pharmaobservatory 0.1.3 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +101 -4
- data/docs/BiomarkerBqpAssertionsRow.md +1 -1
- data/docs/BiomarkerEvidenceRow.md +1 -1
- data/docs/BiomarkerLiteratureRow.md +1 -1
- data/docs/BiomarkerRelationsResponse.md +58 -0
- data/docs/BiomarkerRelationsRow.md +54 -0
- data/docs/BiomarkerSampleCoverageResponse.md +58 -0
- data/docs/BiomarkerSampleCoverageRow.md +36 -0
- data/docs/BiomarkerSamplePrevalenceResponse.md +58 -0
- data/docs/BiomarkerSamplePrevalenceRow.md +56 -0
- data/docs/BiomarkerValidationResponse.md +58 -0
- data/docs/BiomarkerValidationRow.md +70 -0
- data/docs/BiomarkersApi.md +320 -0
- data/docs/BiomarkersRow.md +2 -2
- data/docs/CellLinesRow.md +1 -1
- data/docs/CompaniesApi.md +410 -0
- data/docs/CompaniesRecord.md +1 -1
- data/docs/CompaniesRecordAttributes.md +18 -0
- data/docs/CompaniesRow.md +7 -3
- data/docs/CompanyAssetsResponse.md +58 -0
- data/docs/CompanyAssetsRow.md +42 -0
- data/docs/CompanyFundingEventsResponse.md +58 -0
- data/docs/CompanyFundingEventsRow.md +62 -0
- data/docs/CompanyFundingSummaryResponse.md +58 -0
- data/docs/CompanyFundingSummaryRow.md +46 -0
- data/docs/CompanyProgramsRow.md +2 -2
- data/docs/ConditionAdverseEventsResponse.md +58 -0
- data/docs/ConditionAdverseEventsRow.md +24 -0
- data/docs/ConditionBurdenResponse.md +58 -0
- data/docs/ConditionBurdenRow.md +32 -0
- data/docs/ConditionDeliveryResponse.md +58 -0
- data/docs/ConditionDeliveryRow.md +44 -0
- data/docs/ConditionDrugsResponse.md +58 -0
- data/docs/ConditionDrugsRow.md +26 -0
- data/docs/ConditionPrevalenceResponse.md +58 -0
- data/docs/ConditionPrevalenceRow.md +62 -0
- data/docs/ConditionPublicationsResponse.md +58 -0
- data/docs/ConditionPublicationsRow.md +32 -0
- data/docs/ConditionSitesResponse.md +58 -0
- data/docs/ConditionSitesRow.md +28 -0
- data/docs/ConditionTrialsResponse.md +58 -0
- data/docs/ConditionTrialsRow.md +58 -0
- data/docs/ConditionsApi.md +953 -0
- data/docs/ConditionsRecord.md +38 -0
- data/docs/ConditionsRecordAttributes.md +20 -0
- data/docs/ConditionsResponse.md +58 -0
- data/docs/ConditionsRow.md +32 -0
- data/docs/DrugPatentCliffRow.md +1 -1
- data/docs/InstitutionalHoldingsRow.md +3 -1
- data/docs/LegalEntitiesApi.md +160 -0
- data/docs/LegalEntitiesRow.md +1 -1
- data/docs/OwnershipPositionsResponse.md +58 -0
- data/docs/OwnershipPositionsRow.md +100 -0
- data/docs/PdufaDatesRow.md +2 -2
- data/docs/SiteCroTrialsRow.md +1 -1
- data/docs/SiteTrialConditionsRow.md +1 -1
- data/docs/SiteTrialDrugsRow.md +1 -1
- data/docs/SiteTrialsRow.md +1 -1
- data/docs/SponsorRecruitmentByPhaseRow.md +2 -2
- data/docs/SponsorRecruitmentDurationRow.md +1 -1
- data/docs/SponsorTrialsRow.md +2 -2
- data/docs/TrialAdverseEventsResponse.md +58 -0
- data/docs/TrialAdverseEventsRow.md +28 -0
- data/docs/TrialChangesResponse.md +58 -0
- data/docs/TrialChangesRow.md +36 -0
- data/docs/TrialDeliveryResponse.md +58 -0
- data/docs/TrialDeliveryRow.md +64 -0
- data/docs/TrialDemographicsResponse.md +58 -0
- data/docs/TrialDemographicsRow.md +32 -0
- data/docs/TrialDrugsResponse.md +58 -0
- data/docs/TrialDrugsRow.md +30 -0
- data/docs/TrialEnrollmentHistoryResponse.md +58 -0
- data/docs/TrialEnrollmentHistoryRow.md +36 -0
- data/docs/TrialEnrollmentRateResponse.md +58 -0
- data/docs/TrialEnrollmentRateRow.md +58 -0
- data/docs/TrialExtractedEndpointsResponse.md +58 -0
- data/docs/TrialExtractedEndpointsRow.md +40 -0
- data/docs/TrialOutcomeMeasuresResponse.md +58 -0
- data/docs/TrialOutcomeMeasuresRow.md +28 -0
- data/docs/TrialSitesResponse.md +58 -0
- data/docs/TrialSitesRow.md +46 -0
- data/docs/TrialsApi.md +1033 -0
- data/docs/TrialsRecord.md +38 -0
- data/docs/TrialsRecordAttributes.md +24 -0
- data/docs/TrialsResponse.md +58 -0
- data/docs/TrialsRow.md +116 -0
- data/lib/pharmaobservatory/api/biomarkers_api.rb +336 -0
- data/lib/pharmaobservatory/api/companies_api.rb +455 -0
- data/lib/pharmaobservatory/api/conditions_api.rb +1001 -0
- data/lib/pharmaobservatory/api/legal_entities_api.rb +168 -0
- data/lib/pharmaobservatory/api/trials_api.rb +1085 -0
- data/lib/pharmaobservatory/models/biomarker_bqp_assertions_row.rb +1 -1
- data/lib/pharmaobservatory/models/biomarker_evidence_row.rb +1 -1
- data/lib/pharmaobservatory/models/biomarker_literature_row.rb +1 -1
- data/lib/pharmaobservatory/models/biomarker_relations_response.rb +478 -0
- data/lib/pharmaobservatory/models/biomarker_relations_row.rb +421 -0
- data/lib/pharmaobservatory/models/biomarker_sample_coverage_response.rb +478 -0
- data/lib/pharmaobservatory/models/biomarker_sample_coverage_row.rb +322 -0
- data/lib/pharmaobservatory/models/biomarker_sample_prevalence_response.rb +478 -0
- data/lib/pharmaobservatory/models/biomarker_sample_prevalence_row.rb +436 -0
- data/lib/pharmaobservatory/models/biomarker_validation_response.rb +478 -0
- data/lib/pharmaobservatory/models/biomarker_validation_row.rb +509 -0
- data/lib/pharmaobservatory/models/biomarkers_row.rb +2 -2
- data/lib/pharmaobservatory/models/cell_lines_row.rb +1 -1
- data/lib/pharmaobservatory/models/companies_record.rb +1 -1
- data/lib/pharmaobservatory/models/companies_record_attributes.rb +220 -0
- data/lib/pharmaobservatory/models/companies_row.rb +29 -7
- data/lib/pharmaobservatory/models/company_assets_response.rb +478 -0
- data/lib/pharmaobservatory/models/company_assets_row.rb +355 -0
- data/lib/pharmaobservatory/models/company_funding_events_response.rb +478 -0
- data/lib/pharmaobservatory/models/company_funding_events_row.rb +465 -0
- data/lib/pharmaobservatory/models/company_funding_summary_response.rb +478 -0
- data/lib/pharmaobservatory/models/company_funding_summary_row.rb +377 -0
- data/lib/pharmaobservatory/models/company_programs_row.rb +2 -2
- data/lib/pharmaobservatory/models/condition_adverse_events_response.rb +478 -0
- data/lib/pharmaobservatory/models/condition_adverse_events_row.rb +256 -0
- data/lib/pharmaobservatory/models/condition_burden_response.rb +478 -0
- data/lib/pharmaobservatory/models/condition_burden_row.rb +300 -0
- data/lib/pharmaobservatory/models/condition_delivery_response.rb +478 -0
- data/lib/pharmaobservatory/models/condition_delivery_row.rb +366 -0
- data/lib/pharmaobservatory/models/condition_drugs_response.rb +478 -0
- data/lib/pharmaobservatory/models/condition_drugs_row.rb +267 -0
- data/lib/pharmaobservatory/models/condition_prevalence_response.rb +478 -0
- data/lib/pharmaobservatory/models/condition_prevalence_row.rb +465 -0
- data/lib/pharmaobservatory/models/condition_publications_response.rb +478 -0
- data/lib/pharmaobservatory/models/condition_publications_row.rb +300 -0
- data/lib/pharmaobservatory/models/condition_sites_response.rb +478 -0
- data/lib/pharmaobservatory/models/condition_sites_row.rb +278 -0
- data/lib/pharmaobservatory/models/condition_trials_response.rb +478 -0
- data/lib/pharmaobservatory/models/condition_trials_row.rb +443 -0
- data/lib/pharmaobservatory/models/conditions_record.rb +385 -0
- data/lib/pharmaobservatory/models/conditions_record_attributes.rb +229 -0
- data/lib/pharmaobservatory/models/conditions_response.rb +478 -0
- data/lib/pharmaobservatory/models/conditions_row.rb +304 -0
- data/lib/pharmaobservatory/models/drug_patent_cliff_row.rb +1 -1
- data/lib/pharmaobservatory/models/institutional_holdings_row.rb +13 -2
- data/lib/pharmaobservatory/models/legal_entities_row.rb +1 -1
- data/lib/pharmaobservatory/models/ownership_positions_response.rb +478 -0
- data/lib/pharmaobservatory/models/ownership_positions_row.rb +674 -0
- data/lib/pharmaobservatory/models/pdufa_dates_row.rb +2 -2
- data/lib/pharmaobservatory/models/site_cro_trials_row.rb +1 -1
- data/lib/pharmaobservatory/models/site_trial_conditions_row.rb +1 -1
- data/lib/pharmaobservatory/models/site_trial_drugs_row.rb +1 -1
- data/lib/pharmaobservatory/models/site_trials_row.rb +1 -1
- data/lib/pharmaobservatory/models/sponsor_recruitment_by_phase_row.rb +2 -2
- data/lib/pharmaobservatory/models/sponsor_recruitment_duration_row.rb +1 -1
- data/lib/pharmaobservatory/models/sponsor_trials_row.rb +2 -2
- data/lib/pharmaobservatory/models/trial_adverse_events_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_adverse_events_row.rb +278 -0
- data/lib/pharmaobservatory/models/trial_changes_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_changes_row.rb +328 -0
- data/lib/pharmaobservatory/models/trial_delivery_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_delivery_row.rb +476 -0
- data/lib/pharmaobservatory/models/trial_demographics_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_demographics_row.rb +300 -0
- data/lib/pharmaobservatory/models/trial_drugs_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_drugs_row.rb +291 -0
- data/lib/pharmaobservatory/models/trial_enrollment_history_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_enrollment_history_row.rb +322 -0
- data/lib/pharmaobservatory/models/trial_enrollment_rate_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_enrollment_rate_row.rb +443 -0
- data/lib/pharmaobservatory/models/trial_extracted_endpoints_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_extracted_endpoints_row.rb +346 -0
- data/lib/pharmaobservatory/models/trial_outcome_measures_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_outcome_measures_row.rb +278 -0
- data/lib/pharmaobservatory/models/trial_sites_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_sites_row.rb +377 -0
- data/lib/pharmaobservatory/models/trials_record.rb +385 -0
- data/lib/pharmaobservatory/models/trials_record_attributes.rb +247 -0
- data/lib/pharmaobservatory/models/trials_response.rb +478 -0
- data/lib/pharmaobservatory/models/trials_row.rb +784 -0
- data/lib/pharmaobservatory/version.rb +1 -1
- data/lib/pharmaobservatory.rb +63 -0
- metadata +127 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7f85718cec299f3a618cbc9b1607b83decbfa6c72096205d511981db66b4cafa
|
|
4
|
+
data.tar.gz: 0c2d7357f38aef10fc7ba1c5166e6731626fc95b44616673d9a95da96f9493af
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f11e33ee47613994f1a209f834d24ed3bebde0180e43e08ec06d71d534a64d64092938614bbd76b68546e0a466ae24c808db5869de9bf46a17c80db2d2ccccb9
|
|
7
|
+
data.tar.gz: 5e8f5c970e270dbdf51bde36d698945e08313ba1a0f24a1357fe57db852f363b8476ad7ece59d5f1d80082a619e30148c61e282b4684bb3146632efa9d0d4b56
|
data/README.md
CHANGED
|
@@ -39,7 +39,7 @@ Read-only REST API over the Pharma Observatory biomedical data platform. Referen
|
|
|
39
39
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
40
40
|
|
|
41
41
|
- API version: 1.0.0
|
|
42
|
-
- Package version: 0.1.
|
|
42
|
+
- Package version: 0.1.4
|
|
43
43
|
- Generator version: 7.13.0
|
|
44
44
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
45
45
|
|
|
@@ -56,16 +56,16 @@ gem build pharmaobservatory.gemspec
|
|
|
56
56
|
Then either install the gem locally:
|
|
57
57
|
|
|
58
58
|
```shell
|
|
59
|
-
gem install ./pharmaobservatory-0.1.
|
|
59
|
+
gem install ./pharmaobservatory-0.1.4.gem
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
(for development, run `gem install --dev ./pharmaobservatory-0.1.
|
|
62
|
+
(for development, run `gem install --dev ./pharmaobservatory-0.1.4.gem` to install the development dependencies)
|
|
63
63
|
|
|
64
64
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
65
65
|
|
|
66
66
|
Finally add this to the Gemfile:
|
|
67
67
|
|
|
68
|
-
gem 'pharmaobservatory', '~> 0.1.
|
|
68
|
+
gem 'pharmaobservatory', '~> 0.1.4'
|
|
69
69
|
|
|
70
70
|
### Install from Git
|
|
71
71
|
|
|
@@ -123,6 +123,10 @@ Class | Method | HTTP request | Description
|
|
|
123
123
|
*PharmaObservatory::BiomarkersApi* | [**biomarkers_biomarker_evidence**](docs/BiomarkersApi.md#biomarkers_biomarker_evidence) | **GET** /api/v1/biomarkers/{id}/biomarker_evidence | Biomarker evidence
|
|
124
124
|
*PharmaObservatory::BiomarkersApi* | [**biomarkers_biomarker_literature**](docs/BiomarkersApi.md#biomarkers_biomarker_literature) | **GET** /api/v1/biomarkers/{id}/biomarker_literature | Trial-cited literature mentions
|
|
125
125
|
*PharmaObservatory::BiomarkersApi* | [**biomarkers_biomarker_publishing_companies**](docs/BiomarkersApi.md#biomarkers_biomarker_publishing_companies) | **GET** /api/v1/biomarkers/{id}/biomarker_publishing_companies | Companies publishing on a biomarker
|
|
126
|
+
*PharmaObservatory::BiomarkersApi* | [**biomarkers_biomarker_relations**](docs/BiomarkersApi.md#biomarkers_biomarker_relations) | **GET** /api/v1/biomarkers/{id}/biomarker_relations | Literature-extracted relations
|
|
127
|
+
*PharmaObservatory::BiomarkersApi* | [**biomarkers_biomarker_sample_coverage**](docs/BiomarkersApi.md#biomarkers_biomarker_sample_coverage) | **GET** /api/v1/biomarkers/{id}/biomarker_sample_coverage | Human sample screening coverage (GDC)
|
|
128
|
+
*PharmaObservatory::BiomarkersApi* | [**biomarkers_biomarker_sample_prevalence**](docs/BiomarkersApi.md#biomarkers_biomarker_sample_prevalence) | **GET** /api/v1/biomarkers/{id}/biomarker_sample_prevalence | Human sample screening reference (GDC cohorts)
|
|
129
|
+
*PharmaObservatory::BiomarkersApi* | [**biomarkers_biomarker_validation**](docs/BiomarkersApi.md#biomarkers_biomarker_validation) | **GET** /api/v1/biomarkers/{id}/biomarker_validation | Biomarker validation ladder
|
|
126
130
|
*PharmaObservatory::BiomarkersApi* | [**biomarkers_biomarker_variant_mentions**](docs/BiomarkersApi.md#biomarkers_biomarker_variant_mentions) | **GET** /api/v1/biomarkers/{id}/biomarker_variant_mentions | Protein variant mentions
|
|
127
131
|
*PharmaObservatory::BiomarkersApi* | [**biomarkers_get**](docs/BiomarkersApi.md#biomarkers_get) | **GET** /api/v1/biomarkers/{id} | One biomarker
|
|
128
132
|
*PharmaObservatory::BiomarkersApi* | [**biomarkers_list**](docs/BiomarkersApi.md#biomarkers_list) | **GET** /api/v1/biomarkers | List biomarkers
|
|
@@ -131,6 +135,10 @@ Class | Method | HTTP request | Description
|
|
|
131
135
|
*PharmaObservatory::CompaniesApi* | [**companies_biomarker_bqp_assertions**](docs/CompaniesApi.md#companies_biomarker_bqp_assertions) | **GET** /api/v1/companies/{id}/biomarker_bqp_assertions | FDA biomarker qualification projects
|
|
132
136
|
*PharmaObservatory::CompaniesApi* | [**companies_biomarker_cdx_assertions**](docs/CompaniesApi.md#companies_biomarker_cdx_assertions) | **GET** /api/v1/companies/{id}/biomarker_cdx_assertions | FDA companion diagnostic assertions
|
|
133
137
|
*PharmaObservatory::CompaniesApi* | [**companies_biomarker_publishing_companies**](docs/CompaniesApi.md#companies_biomarker_publishing_companies) | **GET** /api/v1/companies/{id}/biomarker_publishing_companies | Companies publishing on a biomarker
|
|
138
|
+
*PharmaObservatory::CompaniesApi* | [**companies_biomarker_validation**](docs/CompaniesApi.md#companies_biomarker_validation) | **GET** /api/v1/companies/{id}/biomarker_validation | Biomarker validation ladder
|
|
139
|
+
*PharmaObservatory::CompaniesApi* | [**companies_company_assets**](docs/CompaniesApi.md#companies_company_assets) | **GET** /api/v1/companies/{id}/company_assets | Company assets (approved and marketed drugs)
|
|
140
|
+
*PharmaObservatory::CompaniesApi* | [**companies_company_funding_events**](docs/CompaniesApi.md#companies_company_funding_events) | **GET** /api/v1/companies/{id}/company_funding_events | Company funding events
|
|
141
|
+
*PharmaObservatory::CompaniesApi* | [**companies_company_funding_summary**](docs/CompaniesApi.md#companies_company_funding_summary) | **GET** /api/v1/companies/{id}/company_funding_summary | Company funding summary
|
|
134
142
|
*PharmaObservatory::CompaniesApi* | [**companies_company_members**](docs/CompaniesApi.md#companies_company_members) | **GET** /api/v1/companies/{id}/company_members | Company members
|
|
135
143
|
*PharmaObservatory::CompaniesApi* | [**companies_company_programs**](docs/CompaniesApi.md#companies_company_programs) | **GET** /api/v1/companies/{id}/company_programs | Company programs
|
|
136
144
|
*PharmaObservatory::CompaniesApi* | [**companies_company_targets**](docs/CompaniesApi.md#companies_company_targets) | **GET** /api/v1/companies/{id}/company_targets | Targets a company pursues
|
|
@@ -139,18 +147,33 @@ Class | Method | HTTP request | Description
|
|
|
139
147
|
*PharmaObservatory::CompaniesApi* | [**companies_institutional_holdings**](docs/CompaniesApi.md#companies_institutional_holdings) | **GET** /api/v1/companies/{id}/institutional_holdings | Institutional holdings (SEC Form 13F)
|
|
140
148
|
*PharmaObservatory::CompaniesApi* | [**companies_legal_entities**](docs/CompaniesApi.md#companies_legal_entities) | **GET** /api/v1/companies/{id}/legal_entities | Legal entities
|
|
141
149
|
*PharmaObservatory::CompaniesApi* | [**companies_list**](docs/CompaniesApi.md#companies_list) | **GET** /api/v1/companies | List companies
|
|
150
|
+
*PharmaObservatory::CompaniesApi* | [**companies_ownership_positions**](docs/CompaniesApi.md#companies_ownership_positions) | **GET** /api/v1/companies/{id}/ownership_positions | Ownership and control positions
|
|
142
151
|
*PharmaObservatory::CompaniesApi* | [**companies_pdufa_dates**](docs/CompaniesApi.md#companies_pdufa_dates) | **GET** /api/v1/companies/{id}/pdufa_dates | FDA decision dates (PDUFA) and catalysts
|
|
143
152
|
*PharmaObservatory::CompaniesApi* | [**companies_sponsor_recruitment_by_phase**](docs/CompaniesApi.md#companies_sponsor_recruitment_by_phase) | **GET** /api/v1/companies/{id}/sponsor_recruitment_by_phase | Trial recruitment duration by sponsor and phase
|
|
144
153
|
*PharmaObservatory::CompaniesApi* | [**companies_sponsor_recruitment_duration**](docs/CompaniesApi.md#companies_sponsor_recruitment_duration) | **GET** /api/v1/companies/{id}/sponsor_recruitment_duration | Trial recruitment duration by sponsor
|
|
145
154
|
*PharmaObservatory::CompaniesApi* | [**companies_sponsor_trial_start_forecast**](docs/CompaniesApi.md#companies_sponsor_trial_start_forecast) | **GET** /api/v1/companies/{id}/sponsor_trial_start_forecast | Trial-start forecast by sponsor
|
|
146
155
|
*PharmaObservatory::CompaniesApi* | [**companies_sponsor_trials**](docs/CompaniesApi.md#companies_sponsor_trials) | **GET** /api/v1/companies/{id}/sponsor_trials | Sponsor trials
|
|
156
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_company_programs**](docs/ConditionsApi.md#conditions_company_programs) | **GET** /api/v1/conditions/{id}/company_programs | Company programs
|
|
157
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_condition_adverse_events**](docs/ConditionsApi.md#conditions_condition_adverse_events) | **GET** /api/v1/conditions/{id}/condition_adverse_events | Condition adverse events
|
|
158
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_condition_burden**](docs/ConditionsApi.md#conditions_condition_burden) | **GET** /api/v1/conditions/{id}/condition_burden | Condition burden
|
|
159
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_condition_delivery**](docs/ConditionsApi.md#conditions_condition_delivery) | **GET** /api/v1/conditions/{id}/condition_delivery | Condition delivery
|
|
160
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_condition_drugs**](docs/ConditionsApi.md#conditions_condition_drugs) | **GET** /api/v1/conditions/{id}/condition_drugs | Condition drugs
|
|
161
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_condition_prevalence**](docs/ConditionsApi.md#conditions_condition_prevalence) | **GET** /api/v1/conditions/{id}/condition_prevalence | Condition prevalence
|
|
162
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_condition_publications**](docs/ConditionsApi.md#conditions_condition_publications) | **GET** /api/v1/conditions/{id}/condition_publications | Condition publications
|
|
163
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_condition_sites**](docs/ConditionsApi.md#conditions_condition_sites) | **GET** /api/v1/conditions/{id}/condition_sites | Condition sites
|
|
164
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_condition_trials**](docs/ConditionsApi.md#conditions_condition_trials) | **GET** /api/v1/conditions/{id}/condition_trials | Condition trials
|
|
165
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_get**](docs/ConditionsApi.md#conditions_get) | **GET** /api/v1/conditions/{id} | One condition
|
|
166
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_list**](docs/ConditionsApi.md#conditions_list) | **GET** /api/v1/conditions | List conditions
|
|
167
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_pdufa_dates**](docs/ConditionsApi.md#conditions_pdufa_dates) | **GET** /api/v1/conditions/{id}/pdufa_dates | FDA decision dates (PDUFA) and catalysts
|
|
147
168
|
*PharmaObservatory::DatasetsApi* | [**datasets_get**](docs/DatasetsApi.md#datasets_get) | **GET** /api/v1/datasets/{name} | Describe a dataset
|
|
148
169
|
*PharmaObservatory::DatasetsApi* | [**datasets_list**](docs/DatasetsApi.md#datasets_list) | **GET** /api/v1/datasets | List the datasets
|
|
170
|
+
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_company_assets**](docs/LegalEntitiesApi.md#legal_entities_company_assets) | **GET** /api/v1/legal_entities/{id}/company_assets | Company assets (approved and marketed drugs)
|
|
149
171
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_company_programs**](docs/LegalEntitiesApi.md#legal_entities_company_programs) | **GET** /api/v1/legal_entities/{id}/company_programs | Company programs
|
|
150
172
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_drug_patent_cliff**](docs/LegalEntitiesApi.md#legal_entities_drug_patent_cliff) | **GET** /api/v1/legal_entities/{id}/drug_patent_cliff | Patent-cliff exposure
|
|
151
173
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_get**](docs/LegalEntitiesApi.md#legal_entities_get) | **GET** /api/v1/legal_entities/{id} | One legal entity
|
|
152
174
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_institutional_holdings**](docs/LegalEntitiesApi.md#legal_entities_institutional_holdings) | **GET** /api/v1/legal_entities/{id}/institutional_holdings | Institutional holdings (SEC Form 13F)
|
|
153
175
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_list**](docs/LegalEntitiesApi.md#legal_entities_list) | **GET** /api/v1/legal_entities | List legal entities
|
|
176
|
+
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_ownership_positions**](docs/LegalEntitiesApi.md#legal_entities_ownership_positions) | **GET** /api/v1/legal_entities/{id}/ownership_positions | Ownership and control positions
|
|
154
177
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_pdufa_dates**](docs/LegalEntitiesApi.md#legal_entities_pdufa_dates) | **GET** /api/v1/legal_entities/{id}/pdufa_dates | FDA decision dates (PDUFA) and catalysts
|
|
155
178
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_sponsor_recruitment_by_phase**](docs/LegalEntitiesApi.md#legal_entities_sponsor_recruitment_by_phase) | **GET** /api/v1/legal_entities/{id}/sponsor_recruitment_by_phase | Trial recruitment duration by sponsor and phase
|
|
156
179
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_sponsor_recruitment_duration**](docs/LegalEntitiesApi.md#legal_entities_sponsor_recruitment_duration) | **GET** /api/v1/legal_entities/{id}/sponsor_recruitment_duration | Trial recruitment duration by sponsor
|
|
@@ -167,6 +190,19 @@ Class | Method | HTTP request | Description
|
|
|
167
190
|
*PharmaObservatory::SitesApi* | [**sites_site_trial_conditions**](docs/SitesApi.md#sites_site_trial_conditions) | **GET** /api/v1/sites/{id}/site_trial_conditions | Site trial conditions
|
|
168
191
|
*PharmaObservatory::SitesApi* | [**sites_site_trial_drugs**](docs/SitesApi.md#sites_site_trial_drugs) | **GET** /api/v1/sites/{id}/site_trial_drugs | Site trial drugs
|
|
169
192
|
*PharmaObservatory::SitesApi* | [**sites_site_trials**](docs/SitesApi.md#sites_site_trials) | **GET** /api/v1/sites/{id}/site_trials | Site trials
|
|
193
|
+
*PharmaObservatory::TrialsApi* | [**trials_get**](docs/TrialsApi.md#trials_get) | **GET** /api/v1/trials/{id} | One trial
|
|
194
|
+
*PharmaObservatory::TrialsApi* | [**trials_list**](docs/TrialsApi.md#trials_list) | **GET** /api/v1/trials | List trials
|
|
195
|
+
*PharmaObservatory::TrialsApi* | [**trials_sponsor_trials**](docs/TrialsApi.md#trials_sponsor_trials) | **GET** /api/v1/trials/{id}/sponsor_trials | Sponsor trials
|
|
196
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_adverse_events**](docs/TrialsApi.md#trials_trial_adverse_events) | **GET** /api/v1/trials/{id}/trial_adverse_events | Trial adverse events
|
|
197
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_changes**](docs/TrialsApi.md#trials_trial_changes) | **GET** /api/v1/trials/{id}/trial_changes | Trial changes
|
|
198
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_delivery**](docs/TrialsApi.md#trials_trial_delivery) | **GET** /api/v1/trials/{id}/trial_delivery | Trial delivery
|
|
199
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_demographics**](docs/TrialsApi.md#trials_trial_demographics) | **GET** /api/v1/trials/{id}/trial_demographics | Trial demographics
|
|
200
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_drugs**](docs/TrialsApi.md#trials_trial_drugs) | **GET** /api/v1/trials/{id}/trial_drugs | Trial drugs
|
|
201
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_enrollment_history**](docs/TrialsApi.md#trials_trial_enrollment_history) | **GET** /api/v1/trials/{id}/trial_enrollment_history | Trial enrollment history
|
|
202
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_enrollment_rate**](docs/TrialsApi.md#trials_trial_enrollment_rate) | **GET** /api/v1/trials/{id}/trial_enrollment_rate | Trial enrollment rate
|
|
203
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_extracted_endpoints**](docs/TrialsApi.md#trials_trial_extracted_endpoints) | **GET** /api/v1/trials/{id}/trial_extracted_endpoints | Trial extracted endpoints
|
|
204
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_outcome_measures**](docs/TrialsApi.md#trials_trial_outcome_measures) | **GET** /api/v1/trials/{id}/trial_outcome_measures | Trial outcome measures
|
|
205
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_sites**](docs/TrialsApi.md#trials_trial_sites) | **GET** /api/v1/trials/{id}/trial_sites | Trial sites
|
|
170
206
|
|
|
171
207
|
|
|
172
208
|
## Documentation for Models
|
|
@@ -186,6 +222,14 @@ Class | Method | HTTP request | Description
|
|
|
186
222
|
- [PharmaObservatory::BiomarkerLiteratureRow](docs/BiomarkerLiteratureRow.md)
|
|
187
223
|
- [PharmaObservatory::BiomarkerPublishingCompaniesResponse](docs/BiomarkerPublishingCompaniesResponse.md)
|
|
188
224
|
- [PharmaObservatory::BiomarkerPublishingCompaniesRow](docs/BiomarkerPublishingCompaniesRow.md)
|
|
225
|
+
- [PharmaObservatory::BiomarkerRelationsResponse](docs/BiomarkerRelationsResponse.md)
|
|
226
|
+
- [PharmaObservatory::BiomarkerRelationsRow](docs/BiomarkerRelationsRow.md)
|
|
227
|
+
- [PharmaObservatory::BiomarkerSampleCoverageResponse](docs/BiomarkerSampleCoverageResponse.md)
|
|
228
|
+
- [PharmaObservatory::BiomarkerSampleCoverageRow](docs/BiomarkerSampleCoverageRow.md)
|
|
229
|
+
- [PharmaObservatory::BiomarkerSamplePrevalenceResponse](docs/BiomarkerSamplePrevalenceResponse.md)
|
|
230
|
+
- [PharmaObservatory::BiomarkerSamplePrevalenceRow](docs/BiomarkerSamplePrevalenceRow.md)
|
|
231
|
+
- [PharmaObservatory::BiomarkerValidationResponse](docs/BiomarkerValidationResponse.md)
|
|
232
|
+
- [PharmaObservatory::BiomarkerValidationRow](docs/BiomarkerValidationRow.md)
|
|
189
233
|
- [PharmaObservatory::BiomarkerVariantMentionsResponse](docs/BiomarkerVariantMentionsResponse.md)
|
|
190
234
|
- [PharmaObservatory::BiomarkerVariantMentionsRow](docs/BiomarkerVariantMentionsRow.md)
|
|
191
235
|
- [PharmaObservatory::BiomarkersRecord](docs/BiomarkersRecord.md)
|
|
@@ -195,14 +239,41 @@ Class | Method | HTTP request | Description
|
|
|
195
239
|
- [PharmaObservatory::CellLinesResponse](docs/CellLinesResponse.md)
|
|
196
240
|
- [PharmaObservatory::CellLinesRow](docs/CellLinesRow.md)
|
|
197
241
|
- [PharmaObservatory::CompaniesRecord](docs/CompaniesRecord.md)
|
|
242
|
+
- [PharmaObservatory::CompaniesRecordAttributes](docs/CompaniesRecordAttributes.md)
|
|
198
243
|
- [PharmaObservatory::CompaniesResponse](docs/CompaniesResponse.md)
|
|
199
244
|
- [PharmaObservatory::CompaniesRow](docs/CompaniesRow.md)
|
|
245
|
+
- [PharmaObservatory::CompanyAssetsResponse](docs/CompanyAssetsResponse.md)
|
|
246
|
+
- [PharmaObservatory::CompanyAssetsRow](docs/CompanyAssetsRow.md)
|
|
247
|
+
- [PharmaObservatory::CompanyFundingEventsResponse](docs/CompanyFundingEventsResponse.md)
|
|
248
|
+
- [PharmaObservatory::CompanyFundingEventsRow](docs/CompanyFundingEventsRow.md)
|
|
249
|
+
- [PharmaObservatory::CompanyFundingSummaryResponse](docs/CompanyFundingSummaryResponse.md)
|
|
250
|
+
- [PharmaObservatory::CompanyFundingSummaryRow](docs/CompanyFundingSummaryRow.md)
|
|
200
251
|
- [PharmaObservatory::CompanyMembersResponse](docs/CompanyMembersResponse.md)
|
|
201
252
|
- [PharmaObservatory::CompanyMembersRow](docs/CompanyMembersRow.md)
|
|
202
253
|
- [PharmaObservatory::CompanyProgramsResponse](docs/CompanyProgramsResponse.md)
|
|
203
254
|
- [PharmaObservatory::CompanyProgramsRow](docs/CompanyProgramsRow.md)
|
|
204
255
|
- [PharmaObservatory::CompanyTargetsResponse](docs/CompanyTargetsResponse.md)
|
|
205
256
|
- [PharmaObservatory::CompanyTargetsRow](docs/CompanyTargetsRow.md)
|
|
257
|
+
- [PharmaObservatory::ConditionAdverseEventsResponse](docs/ConditionAdverseEventsResponse.md)
|
|
258
|
+
- [PharmaObservatory::ConditionAdverseEventsRow](docs/ConditionAdverseEventsRow.md)
|
|
259
|
+
- [PharmaObservatory::ConditionBurdenResponse](docs/ConditionBurdenResponse.md)
|
|
260
|
+
- [PharmaObservatory::ConditionBurdenRow](docs/ConditionBurdenRow.md)
|
|
261
|
+
- [PharmaObservatory::ConditionDeliveryResponse](docs/ConditionDeliveryResponse.md)
|
|
262
|
+
- [PharmaObservatory::ConditionDeliveryRow](docs/ConditionDeliveryRow.md)
|
|
263
|
+
- [PharmaObservatory::ConditionDrugsResponse](docs/ConditionDrugsResponse.md)
|
|
264
|
+
- [PharmaObservatory::ConditionDrugsRow](docs/ConditionDrugsRow.md)
|
|
265
|
+
- [PharmaObservatory::ConditionPrevalenceResponse](docs/ConditionPrevalenceResponse.md)
|
|
266
|
+
- [PharmaObservatory::ConditionPrevalenceRow](docs/ConditionPrevalenceRow.md)
|
|
267
|
+
- [PharmaObservatory::ConditionPublicationsResponse](docs/ConditionPublicationsResponse.md)
|
|
268
|
+
- [PharmaObservatory::ConditionPublicationsRow](docs/ConditionPublicationsRow.md)
|
|
269
|
+
- [PharmaObservatory::ConditionSitesResponse](docs/ConditionSitesResponse.md)
|
|
270
|
+
- [PharmaObservatory::ConditionSitesRow](docs/ConditionSitesRow.md)
|
|
271
|
+
- [PharmaObservatory::ConditionTrialsResponse](docs/ConditionTrialsResponse.md)
|
|
272
|
+
- [PharmaObservatory::ConditionTrialsRow](docs/ConditionTrialsRow.md)
|
|
273
|
+
- [PharmaObservatory::ConditionsRecord](docs/ConditionsRecord.md)
|
|
274
|
+
- [PharmaObservatory::ConditionsRecordAttributes](docs/ConditionsRecordAttributes.md)
|
|
275
|
+
- [PharmaObservatory::ConditionsResponse](docs/ConditionsResponse.md)
|
|
276
|
+
- [PharmaObservatory::ConditionsRow](docs/ConditionsRow.md)
|
|
206
277
|
- [PharmaObservatory::DatasetAttribution](docs/DatasetAttribution.md)
|
|
207
278
|
- [PharmaObservatory::DatasetBuildState](docs/DatasetBuildState.md)
|
|
208
279
|
- [PharmaObservatory::DatasetColumn](docs/DatasetColumn.md)
|
|
@@ -217,6 +288,8 @@ Class | Method | HTTP request | Description
|
|
|
217
288
|
- [PharmaObservatory::LegalEntitiesRecordAttributes](docs/LegalEntitiesRecordAttributes.md)
|
|
218
289
|
- [PharmaObservatory::LegalEntitiesResponse](docs/LegalEntitiesResponse.md)
|
|
219
290
|
- [PharmaObservatory::LegalEntitiesRow](docs/LegalEntitiesRow.md)
|
|
291
|
+
- [PharmaObservatory::OwnershipPositionsResponse](docs/OwnershipPositionsResponse.md)
|
|
292
|
+
- [PharmaObservatory::OwnershipPositionsRow](docs/OwnershipPositionsRow.md)
|
|
220
293
|
- [PharmaObservatory::PdufaDatesResponse](docs/PdufaDatesResponse.md)
|
|
221
294
|
- [PharmaObservatory::PdufaDatesRow](docs/PdufaDatesRow.md)
|
|
222
295
|
- [PharmaObservatory::QueryError](docs/QueryError.md)
|
|
@@ -250,6 +323,30 @@ Class | Method | HTTP request | Description
|
|
|
250
323
|
- [PharmaObservatory::SponsorTrialStartForecastRow](docs/SponsorTrialStartForecastRow.md)
|
|
251
324
|
- [PharmaObservatory::SponsorTrialsResponse](docs/SponsorTrialsResponse.md)
|
|
252
325
|
- [PharmaObservatory::SponsorTrialsRow](docs/SponsorTrialsRow.md)
|
|
326
|
+
- [PharmaObservatory::TrialAdverseEventsResponse](docs/TrialAdverseEventsResponse.md)
|
|
327
|
+
- [PharmaObservatory::TrialAdverseEventsRow](docs/TrialAdverseEventsRow.md)
|
|
328
|
+
- [PharmaObservatory::TrialChangesResponse](docs/TrialChangesResponse.md)
|
|
329
|
+
- [PharmaObservatory::TrialChangesRow](docs/TrialChangesRow.md)
|
|
330
|
+
- [PharmaObservatory::TrialDeliveryResponse](docs/TrialDeliveryResponse.md)
|
|
331
|
+
- [PharmaObservatory::TrialDeliveryRow](docs/TrialDeliveryRow.md)
|
|
332
|
+
- [PharmaObservatory::TrialDemographicsResponse](docs/TrialDemographicsResponse.md)
|
|
333
|
+
- [PharmaObservatory::TrialDemographicsRow](docs/TrialDemographicsRow.md)
|
|
334
|
+
- [PharmaObservatory::TrialDrugsResponse](docs/TrialDrugsResponse.md)
|
|
335
|
+
- [PharmaObservatory::TrialDrugsRow](docs/TrialDrugsRow.md)
|
|
336
|
+
- [PharmaObservatory::TrialEnrollmentHistoryResponse](docs/TrialEnrollmentHistoryResponse.md)
|
|
337
|
+
- [PharmaObservatory::TrialEnrollmentHistoryRow](docs/TrialEnrollmentHistoryRow.md)
|
|
338
|
+
- [PharmaObservatory::TrialEnrollmentRateResponse](docs/TrialEnrollmentRateResponse.md)
|
|
339
|
+
- [PharmaObservatory::TrialEnrollmentRateRow](docs/TrialEnrollmentRateRow.md)
|
|
340
|
+
- [PharmaObservatory::TrialExtractedEndpointsResponse](docs/TrialExtractedEndpointsResponse.md)
|
|
341
|
+
- [PharmaObservatory::TrialExtractedEndpointsRow](docs/TrialExtractedEndpointsRow.md)
|
|
342
|
+
- [PharmaObservatory::TrialOutcomeMeasuresResponse](docs/TrialOutcomeMeasuresResponse.md)
|
|
343
|
+
- [PharmaObservatory::TrialOutcomeMeasuresRow](docs/TrialOutcomeMeasuresRow.md)
|
|
344
|
+
- [PharmaObservatory::TrialSitesResponse](docs/TrialSitesResponse.md)
|
|
345
|
+
- [PharmaObservatory::TrialSitesRow](docs/TrialSitesRow.md)
|
|
346
|
+
- [PharmaObservatory::TrialsRecord](docs/TrialsRecord.md)
|
|
347
|
+
- [PharmaObservatory::TrialsRecordAttributes](docs/TrialsRecordAttributes.md)
|
|
348
|
+
- [PharmaObservatory::TrialsResponse](docs/TrialsResponse.md)
|
|
349
|
+
- [PharmaObservatory::TrialsRow](docs/TrialsRow.md)
|
|
253
350
|
|
|
254
351
|
|
|
255
352
|
## Documentation for Authorization
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **source_assertion_id** | **String** | The assertion id. | [optional] |
|
|
8
8
|
| **route_key** | **String** | The biomarker's route key, the entry key for the biomarkers object type. | [optional] |
|
|
9
9
|
| **biomarker_id** | **String** | The biomarker key. | [optional] |
|
|
10
|
-
| **ddt_number** | **String** | The
|
|
10
|
+
| **ddt_number** | **String** | The drug development tool number the US Food and Drug Administration (FDA) assigns the project. | [optional] |
|
|
11
11
|
| **ddt_project_id** | **String** | The FDA project id. | [optional] |
|
|
12
12
|
| **project_name** | **String** | The project's name. | [optional] |
|
|
13
13
|
| **bqp_signal** | **String** | The source status of the project. Only qualified means FDA-qualified; every other value is a project status. | [optional] |
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
| **therapeutic_area** | **String** | The therapeutic area. | [optional] |
|
|
18
18
|
| **drug_name** | **String** | The drug as filed. | [optional] |
|
|
19
19
|
| **drug_id** | **String** | The drug key. | [optional] |
|
|
20
|
-
| **molecule_id** | **String** | The molecule key. Null
|
|
20
|
+
| **molecule_id** | **String** | The molecule key. Null on every row: no evidence row carries a molecule. | [optional] |
|
|
21
21
|
| **response** | **String** | The reported response (for example Responsive, Resistant). | [optional] |
|
|
22
22
|
| **score** | **Float** | The association score, for an Open Targets row. | [optional] |
|
|
23
23
|
| **variant_count** | **Integer** | Variants the assertion covers. | [optional] |
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **pmid** | **String** | The PubMed id. | [optional] |
|
|
10
10
|
| **evidence_type** | **String** | The evidence type (a publication mention). | [optional] |
|
|
11
11
|
| **title** | **String** | The paper's title. | [optional] |
|
|
12
|
-
| **journal_nlm_id** | **String** | The journal's NLM id. | [optional] |
|
|
12
|
+
| **journal_nlm_id** | **String** | The journal's National Library of Medicine (NLM) id. | [optional] |
|
|
13
13
|
| **journal_title** | **String** | The journal's title. | [optional] |
|
|
14
14
|
| **pub_year** | **Integer** | The publication year. | [optional] |
|
|
15
15
|
| **citation_count** | **Integer** | Citations, where iCite carries them (null is not measured, never zero). | [optional] |
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# PharmaObservatory::BiomarkerRelationsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **dataset** | **String** | | |
|
|
8
|
+
| **grain** | **String** | | [optional] |
|
|
9
|
+
| **object_type** | **String** | | [optional] |
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
| **scope** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) | | [optional] |
|
|
12
|
+
| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) | | |
|
|
13
|
+
| **rows** | [**Array<BiomarkerRelationsRow>**](BiomarkerRelationsRow.md) | | |
|
|
14
|
+
| **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
|
|
15
|
+
| **next_cursor** | **String** | | [optional] |
|
|
16
|
+
| **sort** | **Array<String>** | | [optional] |
|
|
17
|
+
| **filters** | **Array<Hash<String, Object>>** | | [optional] |
|
|
18
|
+
| **group_by** | **Array<String>** | | [optional] |
|
|
19
|
+
| **measures** | **Array<String>** | | [optional] |
|
|
20
|
+
| **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) | | [optional] |
|
|
21
|
+
| **source_credit** | **String** | | [optional] |
|
|
22
|
+
| **withheld_tiers** | **Array<String>** | | [optional] |
|
|
23
|
+
| **withheld_columns** | **Array<String>** | | [optional] |
|
|
24
|
+
| **freshness** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) | | [optional] |
|
|
25
|
+
| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) | | [optional] |
|
|
26
|
+
| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) | | [optional] |
|
|
27
|
+
| **restriction** | **Hash<String, Object>** | | [optional] |
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
```ruby
|
|
32
|
+
require 'pharmaobservatory'
|
|
33
|
+
|
|
34
|
+
instance = PharmaObservatory::BiomarkerRelationsResponse.new(
|
|
35
|
+
dataset: null,
|
|
36
|
+
grain: null,
|
|
37
|
+
object_type: null,
|
|
38
|
+
id: null,
|
|
39
|
+
scope: null,
|
|
40
|
+
columns: null,
|
|
41
|
+
rows: null,
|
|
42
|
+
total: null,
|
|
43
|
+
next_cursor: null,
|
|
44
|
+
sort: null,
|
|
45
|
+
filters: null,
|
|
46
|
+
group_by: null,
|
|
47
|
+
measures: null,
|
|
48
|
+
attribution: null,
|
|
49
|
+
source_credit: null,
|
|
50
|
+
withheld_tiers: null,
|
|
51
|
+
withheld_columns: null,
|
|
52
|
+
freshness: null,
|
|
53
|
+
build: null,
|
|
54
|
+
build_state: null,
|
|
55
|
+
restriction: null
|
|
56
|
+
)
|
|
57
|
+
```
|
|
58
|
+
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# PharmaObservatory::BiomarkerRelationsRow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **route_key** | **String** | The biomarker's own route key, the entry key for the biomarkers object type (the gene symbol for a gene, the variant key for a protein variant). | [optional] |
|
|
8
|
+
| **biomarker_id** | **String** | The biomarker's key. | [optional] |
|
|
9
|
+
| **biomarker_kind** | **String** | Whether the row describes a gene or a protein variant. | [optional] |
|
|
10
|
+
| **gene_symbol** | **String** | The gene symbol. | [optional] |
|
|
11
|
+
| **amino_acid_change** | **String** | The protein change, for a variant. | [optional] |
|
|
12
|
+
| **related_entity_kind** | **String** | The kind of the related entity (gene, drug or condition). | [optional] |
|
|
13
|
+
| **related_entity_id** | **String** | The related entity's key in its own vocabulary (a gene symbol, a drug id such as unii:..., or a condition key). | [optional] |
|
|
14
|
+
| **related_display_name** | **String** | The related entity's name. | [optional] |
|
|
15
|
+
| **relation_type** | **String** | The source's relation label, as the source states it. | [optional] |
|
|
16
|
+
| **pmid** | **String** | The PubMed id of the paper the relation was extracted from. | [optional] |
|
|
17
|
+
| **title** | **String** | The paper's title. | [optional] |
|
|
18
|
+
| **journal_nlm_id** | **String** | The journal's National Library of Medicine (NLM) id. | [optional] |
|
|
19
|
+
| **journal_title** | **String** | The journal's title. | [optional] |
|
|
20
|
+
| **pub_year** | **Integer** | The paper's publication year. | [optional] |
|
|
21
|
+
| **n_source_assertions** | **Integer** | Source assertions of this relation in the paper. | [optional] |
|
|
22
|
+
| **n_relation_papers** | **Integer** | Papers that carry this biomarker, related entity and relation label. | [optional] |
|
|
23
|
+
| **evidence_type** | **String** | The evidence type (a text-mined relation, never a clinical claim). | [optional] |
|
|
24
|
+
| **source** | **String** | The source of the evidence. | [optional] |
|
|
25
|
+
| **display_order** | **Integer** | The order the web page lists the relation in within its kind. | [optional] |
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
require 'pharmaobservatory'
|
|
31
|
+
|
|
32
|
+
instance = PharmaObservatory::BiomarkerRelationsRow.new(
|
|
33
|
+
route_key: null,
|
|
34
|
+
biomarker_id: null,
|
|
35
|
+
biomarker_kind: null,
|
|
36
|
+
gene_symbol: null,
|
|
37
|
+
amino_acid_change: null,
|
|
38
|
+
related_entity_kind: null,
|
|
39
|
+
related_entity_id: null,
|
|
40
|
+
related_display_name: null,
|
|
41
|
+
relation_type: null,
|
|
42
|
+
pmid: null,
|
|
43
|
+
title: null,
|
|
44
|
+
journal_nlm_id: null,
|
|
45
|
+
journal_title: null,
|
|
46
|
+
pub_year: null,
|
|
47
|
+
n_source_assertions: null,
|
|
48
|
+
n_relation_papers: null,
|
|
49
|
+
evidence_type: null,
|
|
50
|
+
source: null,
|
|
51
|
+
display_order: null
|
|
52
|
+
)
|
|
53
|
+
```
|
|
54
|
+
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# PharmaObservatory::BiomarkerSampleCoverageResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **dataset** | **String** | | |
|
|
8
|
+
| **grain** | **String** | | [optional] |
|
|
9
|
+
| **object_type** | **String** | | [optional] |
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
| **scope** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) | | [optional] |
|
|
12
|
+
| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) | | |
|
|
13
|
+
| **rows** | [**Array<BiomarkerSampleCoverageRow>**](BiomarkerSampleCoverageRow.md) | | |
|
|
14
|
+
| **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
|
|
15
|
+
| **next_cursor** | **String** | | [optional] |
|
|
16
|
+
| **sort** | **Array<String>** | | [optional] |
|
|
17
|
+
| **filters** | **Array<Hash<String, Object>>** | | [optional] |
|
|
18
|
+
| **group_by** | **Array<String>** | | [optional] |
|
|
19
|
+
| **measures** | **Array<String>** | | [optional] |
|
|
20
|
+
| **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) | | [optional] |
|
|
21
|
+
| **source_credit** | **String** | | [optional] |
|
|
22
|
+
| **withheld_tiers** | **Array<String>** | | [optional] |
|
|
23
|
+
| **withheld_columns** | **Array<String>** | | [optional] |
|
|
24
|
+
| **freshness** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) | | [optional] |
|
|
25
|
+
| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) | | [optional] |
|
|
26
|
+
| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) | | [optional] |
|
|
27
|
+
| **restriction** | **Hash<String, Object>** | | [optional] |
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
```ruby
|
|
32
|
+
require 'pharmaobservatory'
|
|
33
|
+
|
|
34
|
+
instance = PharmaObservatory::BiomarkerSampleCoverageResponse.new(
|
|
35
|
+
dataset: null,
|
|
36
|
+
grain: null,
|
|
37
|
+
object_type: null,
|
|
38
|
+
id: null,
|
|
39
|
+
scope: null,
|
|
40
|
+
columns: null,
|
|
41
|
+
rows: null,
|
|
42
|
+
total: null,
|
|
43
|
+
next_cursor: null,
|
|
44
|
+
sort: null,
|
|
45
|
+
filters: null,
|
|
46
|
+
group_by: null,
|
|
47
|
+
measures: null,
|
|
48
|
+
attribution: null,
|
|
49
|
+
source_credit: null,
|
|
50
|
+
withheld_tiers: null,
|
|
51
|
+
withheld_columns: null,
|
|
52
|
+
freshness: null,
|
|
53
|
+
build: null,
|
|
54
|
+
build_state: null,
|
|
55
|
+
restriction: null
|
|
56
|
+
)
|
|
57
|
+
```
|
|
58
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# PharmaObservatory::BiomarkerSampleCoverageRow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **route_key** | **String** | The route key of the gene the variants belong to, the entry key for the biomarkers object type. | [optional] |
|
|
8
|
+
| **gene_symbol** | **String** | The gene symbol. | [optional] |
|
|
9
|
+
| **variant_biomarker_id** | **String** | The variant's own biomarker key. | [optional] |
|
|
10
|
+
| **variant_route_key** | **String** | The variant's own route key (the id its web page uses). | [optional] |
|
|
11
|
+
| **amino_acid_change** | **String** | The protein change, for example p.V600E. | [optional] |
|
|
12
|
+
| **gdc_data_release** | **String** | The Genomic Data Commons data release the match was made against. | [optional] |
|
|
13
|
+
| **normalization_status** | **String** | How the variant matched: resolved_single_ssm, no_exact_ssm, multiple_exact_ssms or source_error. | [optional] |
|
|
14
|
+
| **match_count** | **Integer** | Somatic mutations in the catalogue that encode the same protein change. | [optional] |
|
|
15
|
+
| **resolution_reason** | **String** | The reason for the status, in words. | [optional] |
|
|
16
|
+
| **measured_project_count** | **Integer** | Research projects with an observed frequency for the variant in biomarker_sample_prevalence. | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'pharmaobservatory'
|
|
22
|
+
|
|
23
|
+
instance = PharmaObservatory::BiomarkerSampleCoverageRow.new(
|
|
24
|
+
route_key: null,
|
|
25
|
+
gene_symbol: null,
|
|
26
|
+
variant_biomarker_id: null,
|
|
27
|
+
variant_route_key: null,
|
|
28
|
+
amino_acid_change: null,
|
|
29
|
+
gdc_data_release: null,
|
|
30
|
+
normalization_status: null,
|
|
31
|
+
match_count: null,
|
|
32
|
+
resolution_reason: null,
|
|
33
|
+
measured_project_count: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# PharmaObservatory::BiomarkerSamplePrevalenceResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **dataset** | **String** | | |
|
|
8
|
+
| **grain** | **String** | | [optional] |
|
|
9
|
+
| **object_type** | **String** | | [optional] |
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
| **scope** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) | | [optional] |
|
|
12
|
+
| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) | | |
|
|
13
|
+
| **rows** | [**Array<BiomarkerSamplePrevalenceRow>**](BiomarkerSamplePrevalenceRow.md) | | |
|
|
14
|
+
| **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
|
|
15
|
+
| **next_cursor** | **String** | | [optional] |
|
|
16
|
+
| **sort** | **Array<String>** | | [optional] |
|
|
17
|
+
| **filters** | **Array<Hash<String, Object>>** | | [optional] |
|
|
18
|
+
| **group_by** | **Array<String>** | | [optional] |
|
|
19
|
+
| **measures** | **Array<String>** | | [optional] |
|
|
20
|
+
| **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) | | [optional] |
|
|
21
|
+
| **source_credit** | **String** | | [optional] |
|
|
22
|
+
| **withheld_tiers** | **Array<String>** | | [optional] |
|
|
23
|
+
| **withheld_columns** | **Array<String>** | | [optional] |
|
|
24
|
+
| **freshness** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) | | [optional] |
|
|
25
|
+
| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) | | [optional] |
|
|
26
|
+
| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) | | [optional] |
|
|
27
|
+
| **restriction** | **Hash<String, Object>** | | [optional] |
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
```ruby
|
|
32
|
+
require 'pharmaobservatory'
|
|
33
|
+
|
|
34
|
+
instance = PharmaObservatory::BiomarkerSamplePrevalenceResponse.new(
|
|
35
|
+
dataset: null,
|
|
36
|
+
grain: null,
|
|
37
|
+
object_type: null,
|
|
38
|
+
id: null,
|
|
39
|
+
scope: null,
|
|
40
|
+
columns: null,
|
|
41
|
+
rows: null,
|
|
42
|
+
total: null,
|
|
43
|
+
next_cursor: null,
|
|
44
|
+
sort: null,
|
|
45
|
+
filters: null,
|
|
46
|
+
group_by: null,
|
|
47
|
+
measures: null,
|
|
48
|
+
attribution: null,
|
|
49
|
+
source_credit: null,
|
|
50
|
+
withheld_tiers: null,
|
|
51
|
+
withheld_columns: null,
|
|
52
|
+
freshness: null,
|
|
53
|
+
build: null,
|
|
54
|
+
build_state: null,
|
|
55
|
+
restriction: null
|
|
56
|
+
)
|
|
57
|
+
```
|
|
58
|
+
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# PharmaObservatory::BiomarkerSamplePrevalenceRow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **route_key** | **String** | The route key of the gene the variants belong to, the entry key for the biomarkers object type. | [optional] |
|
|
8
|
+
| **gene_symbol** | **String** | The gene symbol. | [optional] |
|
|
9
|
+
| **variant_biomarker_id** | **String** | The variant's own biomarker key. | [optional] |
|
|
10
|
+
| **variant_route_key** | **String** | The variant's own route key (the id its web page uses). | [optional] |
|
|
11
|
+
| **amino_acid_change** | **String** | The protein change, for example p.V600E. | [optional] |
|
|
12
|
+
| **gdc_ssm_id** | **String** | The identifier of the somatic mutation in the Genomic Data Commons. | [optional] |
|
|
13
|
+
| **gdc_project_id** | **String** | The Genomic Data Commons research project (cohort) the counts come from. | [optional] |
|
|
14
|
+
| **gdc_project_name** | **String** | The name of the research project. | [optional] |
|
|
15
|
+
| **condition_id** | **String** | The condition key (a MeSH, Medical Subject Headings, descriptor id) the project's disease maps to, where one is mapped. | [optional] |
|
|
16
|
+
| **condition_name** | **String** | The mapped condition's MeSH heading. | [optional] |
|
|
17
|
+
| **source_disease_types** | **Array<String>** | The disease types the source states for the project. | [optional] |
|
|
18
|
+
| **source_primary_sites** | **Array<String>** | The primary sites the source states for the project. | [optional] |
|
|
19
|
+
| **affected_case_count** | **Integer** | Cases in the cohort with the exact variant. | [optional] |
|
|
20
|
+
| **ssm_profiled_case_count** | **Integer** | Cases in the cohort profiled for somatic mutations, the denominator of the observed frequency. | [optional] |
|
|
21
|
+
| **all_case_count** | **Integer** | All cases in the project. | [optional] |
|
|
22
|
+
| **observed_frequency** | **Float** | Affected cases over mutation-profiled cases in this cohort. | [optional] |
|
|
23
|
+
| **frequency_ci95_low** | **Float** | Lower bound of the 95 percent confidence interval of the observed frequency. | [optional] |
|
|
24
|
+
| **frequency_ci95_high** | **Float** | Upper bound of the 95 percent confidence interval of the observed frequency. | [optional] |
|
|
25
|
+
| **gdc_data_release** | **String** | The Genomic Data Commons data release the counts come from. | [optional] |
|
|
26
|
+
| **claim_type** | **String** | What the figure states; an observed frequency in a named cohort. | [optional] |
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
```ruby
|
|
31
|
+
require 'pharmaobservatory'
|
|
32
|
+
|
|
33
|
+
instance = PharmaObservatory::BiomarkerSamplePrevalenceRow.new(
|
|
34
|
+
route_key: null,
|
|
35
|
+
gene_symbol: null,
|
|
36
|
+
variant_biomarker_id: null,
|
|
37
|
+
variant_route_key: null,
|
|
38
|
+
amino_acid_change: null,
|
|
39
|
+
gdc_ssm_id: null,
|
|
40
|
+
gdc_project_id: null,
|
|
41
|
+
gdc_project_name: null,
|
|
42
|
+
condition_id: null,
|
|
43
|
+
condition_name: null,
|
|
44
|
+
source_disease_types: null,
|
|
45
|
+
source_primary_sites: null,
|
|
46
|
+
affected_case_count: null,
|
|
47
|
+
ssm_profiled_case_count: null,
|
|
48
|
+
all_case_count: null,
|
|
49
|
+
observed_frequency: null,
|
|
50
|
+
frequency_ci95_low: null,
|
|
51
|
+
frequency_ci95_high: null,
|
|
52
|
+
gdc_data_release: null,
|
|
53
|
+
claim_type: null
|
|
54
|
+
)
|
|
55
|
+
```
|
|
56
|
+
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# PharmaObservatory::BiomarkerValidationResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **dataset** | **String** | | |
|
|
8
|
+
| **grain** | **String** | | [optional] |
|
|
9
|
+
| **object_type** | **String** | | [optional] |
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
| **scope** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) | | [optional] |
|
|
12
|
+
| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) | | |
|
|
13
|
+
| **rows** | [**Array<BiomarkerValidationRow>**](BiomarkerValidationRow.md) | | |
|
|
14
|
+
| **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
|
|
15
|
+
| **next_cursor** | **String** | | [optional] |
|
|
16
|
+
| **sort** | **Array<String>** | | [optional] |
|
|
17
|
+
| **filters** | **Array<Hash<String, Object>>** | | [optional] |
|
|
18
|
+
| **group_by** | **Array<String>** | | [optional] |
|
|
19
|
+
| **measures** | **Array<String>** | | [optional] |
|
|
20
|
+
| **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) | | [optional] |
|
|
21
|
+
| **source_credit** | **String** | | [optional] |
|
|
22
|
+
| **withheld_tiers** | **Array<String>** | | [optional] |
|
|
23
|
+
| **withheld_columns** | **Array<String>** | | [optional] |
|
|
24
|
+
| **freshness** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) | | [optional] |
|
|
25
|
+
| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) | | [optional] |
|
|
26
|
+
| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) | | [optional] |
|
|
27
|
+
| **restriction** | **Hash<String, Object>** | | [optional] |
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
```ruby
|
|
32
|
+
require 'pharmaobservatory'
|
|
33
|
+
|
|
34
|
+
instance = PharmaObservatory::BiomarkerValidationResponse.new(
|
|
35
|
+
dataset: null,
|
|
36
|
+
grain: null,
|
|
37
|
+
object_type: null,
|
|
38
|
+
id: null,
|
|
39
|
+
scope: null,
|
|
40
|
+
columns: null,
|
|
41
|
+
rows: null,
|
|
42
|
+
total: null,
|
|
43
|
+
next_cursor: null,
|
|
44
|
+
sort: null,
|
|
45
|
+
filters: null,
|
|
46
|
+
group_by: null,
|
|
47
|
+
measures: null,
|
|
48
|
+
attribution: null,
|
|
49
|
+
source_credit: null,
|
|
50
|
+
withheld_tiers: null,
|
|
51
|
+
withheld_columns: null,
|
|
52
|
+
freshness: null,
|
|
53
|
+
build: null,
|
|
54
|
+
build_state: null,
|
|
55
|
+
restriction: null
|
|
56
|
+
)
|
|
57
|
+
```
|
|
58
|
+
|