pharmaobservatory 0.1.4 → 0.1.6

data/docs/TargetRegulatoryPrecedentRow.md

@@ -0,0 +1,38 @@
+# PharmaObservatory::TargetRegulatoryPrecedentRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **target_id** | **String** | The target's Ensembl gene id (ENSG followed by eleven digits): the entry key for the targets object type. A gene symbol is not a value here; it is a separate column. | [optional] |
+| **target_symbol** | **String** | The target's HGNC gene symbol (the id the target page address carries). | [optional] |
+| **drug_id** | **String** | The drug's canonical id (the same id the drug datasets use as drug_id). | [optional] |
+| **drug_name** | **String** | The drug's name. | [optional] |
+| **authority** | **String** | The approving authority. | [optional] |
+| **jurisdiction** | **String** | The authority's jurisdiction. | [optional] |
+| **status** | **String** | The approval status the authority records. | [optional] |
+| **first_approval_date** | **Date** | The authority's first approval date of the drug. | [optional] |
+| **approval_id** | **String** | The authority's own approval identifier. | [optional] |
+| **primary_action_type** | **String** | The action type of the drug's curated mechanism on the target. | [optional] |
+| **moa_evidence_source** | **String** | The evidence tier of the mechanism; curated_moa on every row. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::TargetRegulatoryPrecedentRow.new(
+  target_id: null,
+  target_symbol: null,
+  drug_id: null,
+  drug_name: null,
+  authority: null,
+  jurisdiction: null,
+  status: null,
+  first_approval_date: null,
+  approval_id: null,
+  primary_action_type: null,
+  moa_evidence_source: null
+)
+```
+

data/docs/TargetTrialsResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::TargetTrialsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.md) |  | [optional] |
+| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) |  |  |
+| **rows** | [**Array<TargetTrialsRow>**](TargetTrialsRow.md) |  |  |
+| **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
+| **next_cursor** | **String** |  | [optional] |
+| **sort** | **Array<String>** |  | [optional] |
+| **filters** | **Array<Hash<String, Object>>** |  | [optional] |
+| **group_by** | **Array<String>** |  | [optional] |
+| **measures** | **Array<String>** |  | [optional] |
+| **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **withheld_tiers** | **Array<String>** |  | [optional] |
+| **withheld_columns** | **Array<String>** |  | [optional] |
+| **freshness** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::TargetTrialsResponse.new(
+  dataset: null,
+  grain: null,
+  object_type: null,
+  id: null,
+  scope: null,
+  columns: null,
+  rows: null,
+  total: null,
+  next_cursor: null,
+  sort: null,
+  filters: null,
+  group_by: null,
+  measures: null,
+  attribution: null,
+  source_credit: null,
+  withheld_tiers: null,
+  withheld_columns: null,
+  freshness: null,
+  build: null,
+  build_state: null,
+  restriction: null
+)
+```
+

data/docs/TargetTrialsRow.md

@@ -0,0 +1,46 @@
+# PharmaObservatory::TargetTrialsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **target_id** | **String** | The target's Ensembl gene id (ENSG followed by eleven digits): the entry key for the targets object type. A gene symbol is not a value here; it is a separate column. | [optional] |
+| **target_symbol** | **String** | The target's HGNC gene symbol (the id the target page address carries). | [optional] |
+| **trial_id** | **String** | The ClinicalTrials.gov NCT id, the id the trials datasets use. | [optional] |
+| **evidence_source** | **String** | The best evidence tier among the trial's drugs that act on the target. | [optional] |
+| **brief_title** | **String** | The trial's brief title. | [optional] |
+| **phase** | **String** | The registry's phase code (PHASE1, PHASE2, PHASE2/PHASE3, NA and so on). Null when the registry gives no phase (observational and expanded-access trials); phase_label carries the display label for those. | [optional] |
+| **phase_label** | **String** | The trial phase as a display label (Phase 2, Phase 3, Observational, Not applicable, Expanded access, Unknown). The same trial's phase column holds the registry code. | [optional] |
+| **overall_status** | **String** | The registry's overall recruitment status. | [optional] |
+| **start_year** | **Integer** | The year the trial started. | [optional] |
+| **lead_sponsor_name** | **String** | The lead sponsor's name as filed. | [optional] |
+| **lead_sponsor_org_id** | **String** | Legal-entity level: the lead sponsor organization; null when it does not resolve. | [optional] |
+| **lead_sponsor_company_id** | **String** | Company level: the lead sponsor's company; null when none. | [optional] |
+| **lead_sponsor_company_name** | **String** | Display name of the lead sponsor's company. | [optional] |
+| **lead_sponsor_group_id** | **String** | Group level: the lead sponsor's current ultimate parent company; a root company's group is itself. | [optional] |
+| **lead_sponsor_group_name** | **String** | Display name of the lead sponsor's group. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::TargetTrialsRow.new(
+  target_id: null,
+  target_symbol: null,
+  trial_id: null,
+  evidence_source: null,
+  brief_title: null,
+  phase: null,
+  phase_label: null,
+  overall_status: null,
+  start_year: null,
+  lead_sponsor_name: null,
+  lead_sponsor_org_id: null,
+  lead_sponsor_company_id: null,
+  lead_sponsor_company_name: null,
+  lead_sponsor_group_id: null,
+  lead_sponsor_group_name: null
+)
+```
+