pharmaobservatory 0.1.7 → 0.1.8
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 +83 -4
- data/docs/BiomarkerAlleleFrequenciesResponse.md +58 -0
- data/docs/BiomarkerAlleleFrequenciesRow.md +62 -0
- data/docs/BiomarkerAssayProvidersResponse.md +58 -0
- data/docs/BiomarkerAssayProvidersRow.md +72 -0
- data/docs/BiomarkerEvidenceByYearResponse.md +58 -0
- data/docs/BiomarkerEvidenceByYearRow.md +32 -0
- data/docs/BiomarkerTraversalStatusResponse.md +58 -0
- data/docs/BiomarkerTraversalStatusRow.md +36 -0
- data/docs/BiomarkersApi.md +320 -0
- data/docs/CompaniesApi.md +1001 -99
- data/docs/CompanyAssetsRow.md +5 -1
- data/docs/CompanyBiomarkerCapabilityResponse.md +58 -0
- data/docs/CompanyBiomarkerCapabilityRow.md +68 -0
- data/docs/CompanyProgramsRow.md +5 -1
- data/docs/CompanyRareDiseaseDeclarationsResponse.md +58 -0
- data/docs/CompanyRareDiseaseDeclarationsRow.md +52 -0
- data/docs/GxpFacilitiesRow.md +22 -0
- data/docs/LegalEntitiesApi.md +981 -101
- data/docs/LegalEntitiesRecordAttributes.md +6 -0
- data/docs/LegalEntitySecFilingsResponse.md +58 -0
- data/docs/LegalEntitySecFilingsRow.md +44 -0
- data/docs/OrgDisclosureTrendResponse.md +58 -0
- data/docs/OrgDisclosureTrendRow.md +62 -0
- data/docs/OwnershipSourceCoverageResponse.md +58 -0
- data/docs/OwnershipSourceCoverageRow.md +62 -0
- data/docs/ProgramLicensingCandidatesRow.md +5 -1
- data/docs/ProgramsRow.md +1 -1
- data/docs/RwdConductorDeliveryResponse.md +58 -0
- data/docs/RwdConductorDeliveryRow.md +74 -0
- data/docs/RwdConductorFootprintResponse.md +58 -0
- data/docs/RwdConductorFootprintRow.md +40 -0
- data/docs/RwdConductorStudiesResponse.md +58 -0
- data/docs/RwdConductorStudiesRow.md +42 -0
- data/docs/RwdConductorsApi.md +393 -0
- data/docs/RwdConductorsRecord.md +38 -0
- data/docs/RwdConductorsResponse.md +58 -0
- data/docs/RwdConductorsRow.md +72 -0
- data/docs/RwdInstitutionsApi.md +153 -0
- data/docs/RwdInstitutionsRecord.md +38 -0
- data/docs/RwdInstitutionsResponse.md +58 -0
- data/docs/RwdInstitutionsRow.md +154 -0
- data/docs/RwdNetworksApi.md +153 -0
- data/docs/RwdNetworksRecord.md +38 -0
- data/docs/RwdNetworksResponse.md +58 -0
- data/docs/RwdNetworksRow.md +110 -0
- data/docs/RwdStudiesApi.md +80 -0
- data/docs/SbtiCrosscheckResponse.md +58 -0
- data/docs/SbtiCrosscheckRow.md +48 -0
- data/docs/SponsorDeliveryResponse.md +58 -0
- data/docs/SponsorDeliveryRow.md +52 -0
- data/docs/SponsorPatentMentionsResponse.md +58 -0
- data/docs/SponsorPatentMentionsRow.md +42 -0
- data/docs/SponsorTrialConditionsResponse.md +58 -0
- data/docs/SponsorTrialConditionsRow.md +36 -0
- data/docs/SponsorTrialDrugsResponse.md +58 -0
- data/docs/SponsorTrialDrugsRow.md +34 -0
- data/lib/pharmaobservatory/api/biomarkers_api.rb +336 -0
- data/lib/pharmaobservatory/api/companies_api.rb +1131 -130
- data/lib/pharmaobservatory/api/legal_entities_api.rb +1047 -123
- data/lib/pharmaobservatory/api/rwd_conductors_api.rb +413 -0
- data/lib/pharmaobservatory/api/rwd_institutions_api.rb +161 -0
- data/lib/pharmaobservatory/api/rwd_networks_api.rb +161 -0
- data/lib/pharmaobservatory/api/rwd_studies_api.rb +84 -0
- data/lib/pharmaobservatory/models/biomarker_allele_frequencies_response.rb +478 -0
- data/lib/pharmaobservatory/models/biomarker_allele_frequencies_row.rb +465 -0
- data/lib/pharmaobservatory/models/biomarker_assay_providers_response.rb +478 -0
- data/lib/pharmaobservatory/models/biomarker_assay_providers_row.rb +520 -0
- data/lib/pharmaobservatory/models/biomarker_evidence_by_year_response.rb +478 -0
- data/lib/pharmaobservatory/models/biomarker_evidence_by_year_row.rb +300 -0
- data/lib/pharmaobservatory/models/biomarker_traversal_status_response.rb +478 -0
- data/lib/pharmaobservatory/models/biomarker_traversal_status_row.rb +322 -0
- data/lib/pharmaobservatory/models/company_assets_row.rb +24 -2
- data/lib/pharmaobservatory/models/company_biomarker_capability_response.rb +478 -0
- data/lib/pharmaobservatory/models/company_biomarker_capability_row.rb +498 -0
- data/lib/pharmaobservatory/models/company_programs_row.rb +24 -2
- data/lib/pharmaobservatory/models/company_rare_disease_declarations_response.rb +478 -0
- data/lib/pharmaobservatory/models/company_rare_disease_declarations_row.rb +410 -0
- data/lib/pharmaobservatory/models/gxp_facilities_row.rb +122 -1
- data/lib/pharmaobservatory/models/legal_entities_record_attributes.rb +28 -1
- data/lib/pharmaobservatory/models/legal_entity_sec_filings_response.rb +478 -0
- data/lib/pharmaobservatory/models/legal_entity_sec_filings_row.rb +370 -0
- data/lib/pharmaobservatory/models/org_disclosure_trend_response.rb +478 -0
- data/lib/pharmaobservatory/models/org_disclosure_trend_row.rb +465 -0
- data/lib/pharmaobservatory/models/ownership_source_coverage_response.rb +478 -0
- data/lib/pharmaobservatory/models/ownership_source_coverage_row.rb +465 -0
- data/lib/pharmaobservatory/models/program_licensing_candidates_row.rb +24 -2
- data/lib/pharmaobservatory/models/programs_row.rb +1 -1
- data/lib/pharmaobservatory/models/rwd_conductor_delivery_response.rb +478 -0
- data/lib/pharmaobservatory/models/rwd_conductor_delivery_row.rb +537 -0
- data/lib/pharmaobservatory/models/rwd_conductor_footprint_response.rb +478 -0
- data/lib/pharmaobservatory/models/rwd_conductor_footprint_row.rb +346 -0
- data/lib/pharmaobservatory/models/rwd_conductor_studies_response.rb +478 -0
- data/lib/pharmaobservatory/models/rwd_conductor_studies_row.rb +355 -0
- data/lib/pharmaobservatory/models/rwd_conductors_record.rb +385 -0
- data/lib/pharmaobservatory/models/rwd_conductors_response.rb +478 -0
- data/lib/pharmaobservatory/models/rwd_conductors_row.rb +526 -0
- data/lib/pharmaobservatory/models/rwd_institutions_record.rb +385 -0
- data/lib/pharmaobservatory/models/rwd_institutions_response.rb +478 -0
- data/lib/pharmaobservatory/models/rwd_institutions_row.rb +981 -0
- data/lib/pharmaobservatory/models/rwd_networks_record.rb +385 -0
- data/lib/pharmaobservatory/models/rwd_networks_response.rb +478 -0
- data/lib/pharmaobservatory/models/rwd_networks_row.rb +733 -0
- data/lib/pharmaobservatory/models/sbti_crosscheck_response.rb +478 -0
- data/lib/pharmaobservatory/models/sbti_crosscheck_row.rb +388 -0
- data/lib/pharmaobservatory/models/sponsor_delivery_response.rb +478 -0
- data/lib/pharmaobservatory/models/sponsor_delivery_row.rb +410 -0
- data/lib/pharmaobservatory/models/sponsor_patent_mentions_response.rb +478 -0
- data/lib/pharmaobservatory/models/sponsor_patent_mentions_row.rb +355 -0
- data/lib/pharmaobservatory/models/sponsor_trial_conditions_response.rb +478 -0
- data/lib/pharmaobservatory/models/sponsor_trial_conditions_row.rb +322 -0
- data/lib/pharmaobservatory/models/sponsor_trial_drugs_response.rb +478 -0
- data/lib/pharmaobservatory/models/sponsor_trial_drugs_row.rb +311 -0
- data/lib/pharmaobservatory/version.rb +1 -1
- data/lib/pharmaobservatory.rb +46 -0
- metadata +94 -2
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# PharmaObservatory::BiomarkerEvidenceByYearRow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **route_key** | **String** | The gene's route key, the entry key for the biomarkers object type; the gene symbol. | [optional] |
|
|
8
|
+
| **gene_symbol** | **String** | The gene symbol. | [optional] |
|
|
9
|
+
| **evidence_type** | **String** | The evidence arm. trial_mention counts trials that mention the gene (the year is the trial start year); publication_mention counts papers cited by registered trials that mention it (the year is the publication year). | [optional] |
|
|
10
|
+
| **evidence_year** | **Integer** | The year of the mentions. Null for the undated class. | [optional] |
|
|
11
|
+
| **year_class** | **String** | How the year is treated. plotted: inside the window the web chart draws. pre_window: before 1990. future_dated: after the current year. corpus_incomplete: after the latest year the arm's corpus covers. undated: the source has no year. | [optional] |
|
|
12
|
+
| **n_mentions** | **Integer** | Mentions of the gene in that arm, year and class. A document that mentions the gene more than once counts once per mention. | [optional] |
|
|
13
|
+
| **n_documents** | **Integer** | Distinct documents (trials or papers) that mention the gene in that arm, year and class. | [optional] |
|
|
14
|
+
| **year_denominator** | **Integer** | Distinct documents in that arm and year that mention any gene, the denominator of the gene's share of the year. | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'pharmaobservatory'
|
|
20
|
+
|
|
21
|
+
instance = PharmaObservatory::BiomarkerEvidenceByYearRow.new(
|
|
22
|
+
route_key: null,
|
|
23
|
+
gene_symbol: null,
|
|
24
|
+
evidence_type: null,
|
|
25
|
+
evidence_year: null,
|
|
26
|
+
year_class: null,
|
|
27
|
+
n_mentions: null,
|
|
28
|
+
n_documents: null,
|
|
29
|
+
year_denominator: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# PharmaObservatory::BiomarkerTraversalStatusResponse
|
|
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** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.md) | | [optional] |
|
|
12
|
+
| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) | | |
|
|
13
|
+
| **rows** | [**Array<BiomarkerTraversalStatusRow>**](BiomarkerTraversalStatusRow.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** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) | | [optional] |
|
|
25
|
+
| **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.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::BiomarkerTraversalStatusResponse.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::BiomarkerTraversalStatusRow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **route_key** | **String** | The biomarker's route key, the entry key for the biomarkers object type. | [optional] |
|
|
8
|
+
| **biomarker_id** | **String** | The biomarker's own key. | [optional] |
|
|
9
|
+
| **biomarker_kind** | **String** | What kind of biomarker the row describes. | [optional] |
|
|
10
|
+
| **traversal_key** | **String** | The traversal. | [optional] |
|
|
11
|
+
| **display_order** | **Integer** | The order the web page lists the traversals in, one to nine. | [optional] |
|
|
12
|
+
| **traversal_name** | **String** | The traversal's display name. | [optional] |
|
|
13
|
+
| **applicability_state** | **String** | applicable: measured for this kind of biomarker. inapplicable: does not apply to this kind. not_measured: applies in principle but the corpus is not mined for this kind yet. | [optional] |
|
|
14
|
+
| **context_mode** | **String** | How the traversal reads for this biomarker. direct: its own rows. parent_gene: the variant's gene rows. parent_and_exact: the gene's rows plus the exact variant's. child_variants: the gene's variant children. source_linked: shown when a source assertion resolves to it. bridge_deferred: depends on a bridge that has not landed. none: no traversal. | [optional] |
|
|
15
|
+
| **reason_code** | **String** | The code behind the applicability state and context mode; state_detail is its sentence. | [optional] |
|
|
16
|
+
| **state_detail** | **String** | The sentence the web page prints for the reason code. | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'pharmaobservatory'
|
|
22
|
+
|
|
23
|
+
instance = PharmaObservatory::BiomarkerTraversalStatusRow.new(
|
|
24
|
+
route_key: null,
|
|
25
|
+
biomarker_id: null,
|
|
26
|
+
biomarker_kind: null,
|
|
27
|
+
traversal_key: null,
|
|
28
|
+
display_order: null,
|
|
29
|
+
traversal_name: null,
|
|
30
|
+
applicability_state: null,
|
|
31
|
+
context_mode: null,
|
|
32
|
+
reason_code: null,
|
|
33
|
+
state_detail: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
data/docs/BiomarkersApi.md
CHANGED
|
@@ -4,22 +4,105 @@ All URIs are relative to *https://pharmaobservatory.com*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**biomarkers_biomarker_allele_frequencies**](BiomarkersApi.md#biomarkers_biomarker_allele_frequencies) | **GET** /api/v1/biomarkers/{id}/biomarker_allele_frequencies | Population allele frequency of protein variants (gnomAD) |
|
|
7
8
|
| [**biomarkers_biomarker_assay_evidence**](BiomarkersApi.md#biomarkers_biomarker_assay_evidence) | **GET** /api/v1/biomarkers/{id}/biomarker_assay_evidence | Biomarker assay evidence from the literature |
|
|
9
|
+
| [**biomarkers_biomarker_assay_providers**](BiomarkersApi.md#biomarkers_biomarker_assay_providers) | **GET** /api/v1/biomarkers/{id}/biomarker_assay_providers | Biomarker assay providers (from validating papers) |
|
|
8
10
|
| [**biomarkers_biomarker_assay_whitespace**](BiomarkersApi.md#biomarkers_biomarker_assay_whitespace) | **GET** /api/v1/biomarkers/{id}/biomarker_assay_whitespace | Biomarker assay whitespace (evidence against supplier supply) |
|
|
9
11
|
| [**biomarkers_biomarker_bqp_assertions**](BiomarkersApi.md#biomarkers_biomarker_bqp_assertions) | **GET** /api/v1/biomarkers/{id}/biomarker_bqp_assertions | FDA biomarker qualification projects |
|
|
10
12
|
| [**biomarkers_biomarker_cdx_assertions**](BiomarkersApi.md#biomarkers_biomarker_cdx_assertions) | **GET** /api/v1/biomarkers/{id}/biomarker_cdx_assertions | FDA companion diagnostic assertions |
|
|
11
13
|
| [**biomarkers_biomarker_evidence**](BiomarkersApi.md#biomarkers_biomarker_evidence) | **GET** /api/v1/biomarkers/{id}/biomarker_evidence | Biomarker evidence |
|
|
14
|
+
| [**biomarkers_biomarker_evidence_by_year**](BiomarkersApi.md#biomarkers_biomarker_evidence_by_year) | **GET** /api/v1/biomarkers/{id}/biomarker_evidence_by_year | Biomarker evidence by year (trial and publication mentions) |
|
|
12
15
|
| [**biomarkers_biomarker_literature**](BiomarkersApi.md#biomarkers_biomarker_literature) | **GET** /api/v1/biomarkers/{id}/biomarker_literature | Trial-cited literature mentions |
|
|
13
16
|
| [**biomarkers_biomarker_publishing_companies**](BiomarkersApi.md#biomarkers_biomarker_publishing_companies) | **GET** /api/v1/biomarkers/{id}/biomarker_publishing_companies | Companies publishing on a biomarker |
|
|
14
17
|
| [**biomarkers_biomarker_relations**](BiomarkersApi.md#biomarkers_biomarker_relations) | **GET** /api/v1/biomarkers/{id}/biomarker_relations | Literature-extracted relations |
|
|
15
18
|
| [**biomarkers_biomarker_sample_coverage**](BiomarkersApi.md#biomarkers_biomarker_sample_coverage) | **GET** /api/v1/biomarkers/{id}/biomarker_sample_coverage | Human sample screening coverage (GDC) |
|
|
16
19
|
| [**biomarkers_biomarker_sample_prevalence**](BiomarkersApi.md#biomarkers_biomarker_sample_prevalence) | **GET** /api/v1/biomarkers/{id}/biomarker_sample_prevalence | Human sample screening reference (GDC cohorts) |
|
|
20
|
+
| [**biomarkers_biomarker_traversal_status**](BiomarkersApi.md#biomarkers_biomarker_traversal_status) | **GET** /api/v1/biomarkers/{id}/biomarker_traversal_status | Biomarker coverage by traversal |
|
|
17
21
|
| [**biomarkers_biomarker_validation**](BiomarkersApi.md#biomarkers_biomarker_validation) | **GET** /api/v1/biomarkers/{id}/biomarker_validation | Biomarker validation ladder |
|
|
18
22
|
| [**biomarkers_biomarker_variant_mentions**](BiomarkersApi.md#biomarkers_biomarker_variant_mentions) | **GET** /api/v1/biomarkers/{id}/biomarker_variant_mentions | Protein variant mentions |
|
|
19
23
|
| [**biomarkers_get**](BiomarkersApi.md#biomarkers_get) | **GET** /api/v1/biomarkers/{id} | One biomarker |
|
|
20
24
|
| [**biomarkers_list**](BiomarkersApi.md#biomarkers_list) | **GET** /api/v1/biomarkers | List biomarkers |
|
|
21
25
|
|
|
22
26
|
|
|
27
|
+
## biomarkers_biomarker_allele_frequencies
|
|
28
|
+
|
|
29
|
+
> <BiomarkerAlleleFrequenciesResponse> biomarkers_biomarker_allele_frequencies(id, opts)
|
|
30
|
+
|
|
31
|
+
Population allele frequency of protein variants (gnomAD)
|
|
32
|
+
|
|
33
|
+
### Examples
|
|
34
|
+
|
|
35
|
+
```ruby
|
|
36
|
+
require 'time'
|
|
37
|
+
require 'pharmaobservatory'
|
|
38
|
+
# setup authorization
|
|
39
|
+
PharmaObservatory.configure do |config|
|
|
40
|
+
# Configure Bearer authorization (JWT): ApiBearerJwt
|
|
41
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
api_instance = PharmaObservatory::BiomarkersApi.new
|
|
45
|
+
id = 'ESR1' # String |
|
|
46
|
+
opts = {
|
|
47
|
+
cursor: 'cursor_example', # String | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
|
|
48
|
+
limit: 56, # Integer | Rows per page, up to 500 (default 50).
|
|
49
|
+
sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
|
|
50
|
+
group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
|
|
51
|
+
measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
begin
|
|
55
|
+
# Population allele frequency of protein variants (gnomAD)
|
|
56
|
+
result = api_instance.biomarkers_biomarker_allele_frequencies(id, opts)
|
|
57
|
+
p result
|
|
58
|
+
rescue PharmaObservatory::ApiError => e
|
|
59
|
+
puts "Error when calling BiomarkersApi->biomarkers_biomarker_allele_frequencies: #{e}"
|
|
60
|
+
end
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
#### Using the biomarkers_biomarker_allele_frequencies_with_http_info variant
|
|
64
|
+
|
|
65
|
+
This returns an Array which contains the response data, status code and headers.
|
|
66
|
+
|
|
67
|
+
> <Array(<BiomarkerAlleleFrequenciesResponse>, Integer, Hash)> biomarkers_biomarker_allele_frequencies_with_http_info(id, opts)
|
|
68
|
+
|
|
69
|
+
```ruby
|
|
70
|
+
begin
|
|
71
|
+
# Population allele frequency of protein variants (gnomAD)
|
|
72
|
+
data, status_code, headers = api_instance.biomarkers_biomarker_allele_frequencies_with_http_info(id, opts)
|
|
73
|
+
p status_code # => 2xx
|
|
74
|
+
p headers # => { ... }
|
|
75
|
+
p data # => <BiomarkerAlleleFrequenciesResponse>
|
|
76
|
+
rescue PharmaObservatory::ApiError => e
|
|
77
|
+
puts "Error when calling BiomarkersApi->biomarkers_biomarker_allele_frequencies_with_http_info: #{e}"
|
|
78
|
+
end
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Parameters
|
|
82
|
+
|
|
83
|
+
| Name | Type | Description | Notes |
|
|
84
|
+
| ---- | ---- | ----------- | ----- |
|
|
85
|
+
| **id** | **String** | | |
|
|
86
|
+
| **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
|
|
87
|
+
| **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
|
|
88
|
+
| **sort** | **String** | Comma separated columns, a leading minus for descending: sort=a,-b. | [optional] |
|
|
89
|
+
| **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
|
|
90
|
+
| **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
|
|
91
|
+
|
|
92
|
+
### Return type
|
|
93
|
+
|
|
94
|
+
[**BiomarkerAlleleFrequenciesResponse**](BiomarkerAlleleFrequenciesResponse.md)
|
|
95
|
+
|
|
96
|
+
### Authorization
|
|
97
|
+
|
|
98
|
+
[ApiBearerJwt](../README.md#ApiBearerJwt)
|
|
99
|
+
|
|
100
|
+
### HTTP request headers
|
|
101
|
+
|
|
102
|
+
- **Content-Type**: Not defined
|
|
103
|
+
- **Accept**: application/json
|
|
104
|
+
|
|
105
|
+
|
|
23
106
|
## biomarkers_biomarker_assay_evidence
|
|
24
107
|
|
|
25
108
|
> <BiomarkerAssayEvidenceResponse> biomarkers_biomarker_assay_evidence(id, opts)
|
|
@@ -99,6 +182,85 @@ end
|
|
|
99
182
|
- **Accept**: application/json
|
|
100
183
|
|
|
101
184
|
|
|
185
|
+
## biomarkers_biomarker_assay_providers
|
|
186
|
+
|
|
187
|
+
> <BiomarkerAssayProvidersResponse> biomarkers_biomarker_assay_providers(id, opts)
|
|
188
|
+
|
|
189
|
+
Biomarker assay providers (from validating papers)
|
|
190
|
+
|
|
191
|
+
### Examples
|
|
192
|
+
|
|
193
|
+
```ruby
|
|
194
|
+
require 'time'
|
|
195
|
+
require 'pharmaobservatory'
|
|
196
|
+
# setup authorization
|
|
197
|
+
PharmaObservatory.configure do |config|
|
|
198
|
+
# Configure Bearer authorization (JWT): ApiBearerJwt
|
|
199
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
200
|
+
end
|
|
201
|
+
|
|
202
|
+
api_instance = PharmaObservatory::BiomarkersApi.new
|
|
203
|
+
id = 'ESR1' # String |
|
|
204
|
+
opts = {
|
|
205
|
+
cursor: 'cursor_example', # String | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
|
|
206
|
+
limit: 56, # Integer | Rows per page, up to 500 (default 50).
|
|
207
|
+
sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
|
|
208
|
+
group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
|
|
209
|
+
measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
begin
|
|
213
|
+
# Biomarker assay providers (from validating papers)
|
|
214
|
+
result = api_instance.biomarkers_biomarker_assay_providers(id, opts)
|
|
215
|
+
p result
|
|
216
|
+
rescue PharmaObservatory::ApiError => e
|
|
217
|
+
puts "Error when calling BiomarkersApi->biomarkers_biomarker_assay_providers: #{e}"
|
|
218
|
+
end
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
#### Using the biomarkers_biomarker_assay_providers_with_http_info variant
|
|
222
|
+
|
|
223
|
+
This returns an Array which contains the response data, status code and headers.
|
|
224
|
+
|
|
225
|
+
> <Array(<BiomarkerAssayProvidersResponse>, Integer, Hash)> biomarkers_biomarker_assay_providers_with_http_info(id, opts)
|
|
226
|
+
|
|
227
|
+
```ruby
|
|
228
|
+
begin
|
|
229
|
+
# Biomarker assay providers (from validating papers)
|
|
230
|
+
data, status_code, headers = api_instance.biomarkers_biomarker_assay_providers_with_http_info(id, opts)
|
|
231
|
+
p status_code # => 2xx
|
|
232
|
+
p headers # => { ... }
|
|
233
|
+
p data # => <BiomarkerAssayProvidersResponse>
|
|
234
|
+
rescue PharmaObservatory::ApiError => e
|
|
235
|
+
puts "Error when calling BiomarkersApi->biomarkers_biomarker_assay_providers_with_http_info: #{e}"
|
|
236
|
+
end
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
### Parameters
|
|
240
|
+
|
|
241
|
+
| Name | Type | Description | Notes |
|
|
242
|
+
| ---- | ---- | ----------- | ----- |
|
|
243
|
+
| **id** | **String** | | |
|
|
244
|
+
| **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
|
|
245
|
+
| **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
|
|
246
|
+
| **sort** | **String** | Comma separated columns, a leading minus for descending: sort=a,-b. | [optional] |
|
|
247
|
+
| **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
|
|
248
|
+
| **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
|
|
249
|
+
|
|
250
|
+
### Return type
|
|
251
|
+
|
|
252
|
+
[**BiomarkerAssayProvidersResponse**](BiomarkerAssayProvidersResponse.md)
|
|
253
|
+
|
|
254
|
+
### Authorization
|
|
255
|
+
|
|
256
|
+
[ApiBearerJwt](../README.md#ApiBearerJwt)
|
|
257
|
+
|
|
258
|
+
### HTTP request headers
|
|
259
|
+
|
|
260
|
+
- **Content-Type**: Not defined
|
|
261
|
+
- **Accept**: application/json
|
|
262
|
+
|
|
263
|
+
|
|
102
264
|
## biomarkers_biomarker_assay_whitespace
|
|
103
265
|
|
|
104
266
|
> <BiomarkerAssayWhitespaceResponse> biomarkers_biomarker_assay_whitespace(id, opts)
|
|
@@ -415,6 +577,85 @@ end
|
|
|
415
577
|
- **Accept**: application/json
|
|
416
578
|
|
|
417
579
|
|
|
580
|
+
## biomarkers_biomarker_evidence_by_year
|
|
581
|
+
|
|
582
|
+
> <BiomarkerEvidenceByYearResponse> biomarkers_biomarker_evidence_by_year(id, opts)
|
|
583
|
+
|
|
584
|
+
Biomarker evidence by year (trial and publication mentions)
|
|
585
|
+
|
|
586
|
+
### Examples
|
|
587
|
+
|
|
588
|
+
```ruby
|
|
589
|
+
require 'time'
|
|
590
|
+
require 'pharmaobservatory'
|
|
591
|
+
# setup authorization
|
|
592
|
+
PharmaObservatory.configure do |config|
|
|
593
|
+
# Configure Bearer authorization (JWT): ApiBearerJwt
|
|
594
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
595
|
+
end
|
|
596
|
+
|
|
597
|
+
api_instance = PharmaObservatory::BiomarkersApi.new
|
|
598
|
+
id = 'ESR1' # String |
|
|
599
|
+
opts = {
|
|
600
|
+
cursor: 'cursor_example', # String | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
|
|
601
|
+
limit: 56, # Integer | Rows per page, up to 500 (default 50).
|
|
602
|
+
sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
|
|
603
|
+
group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
|
|
604
|
+
measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
|
|
605
|
+
}
|
|
606
|
+
|
|
607
|
+
begin
|
|
608
|
+
# Biomarker evidence by year (trial and publication mentions)
|
|
609
|
+
result = api_instance.biomarkers_biomarker_evidence_by_year(id, opts)
|
|
610
|
+
p result
|
|
611
|
+
rescue PharmaObservatory::ApiError => e
|
|
612
|
+
puts "Error when calling BiomarkersApi->biomarkers_biomarker_evidence_by_year: #{e}"
|
|
613
|
+
end
|
|
614
|
+
```
|
|
615
|
+
|
|
616
|
+
#### Using the biomarkers_biomarker_evidence_by_year_with_http_info variant
|
|
617
|
+
|
|
618
|
+
This returns an Array which contains the response data, status code and headers.
|
|
619
|
+
|
|
620
|
+
> <Array(<BiomarkerEvidenceByYearResponse>, Integer, Hash)> biomarkers_biomarker_evidence_by_year_with_http_info(id, opts)
|
|
621
|
+
|
|
622
|
+
```ruby
|
|
623
|
+
begin
|
|
624
|
+
# Biomarker evidence by year (trial and publication mentions)
|
|
625
|
+
data, status_code, headers = api_instance.biomarkers_biomarker_evidence_by_year_with_http_info(id, opts)
|
|
626
|
+
p status_code # => 2xx
|
|
627
|
+
p headers # => { ... }
|
|
628
|
+
p data # => <BiomarkerEvidenceByYearResponse>
|
|
629
|
+
rescue PharmaObservatory::ApiError => e
|
|
630
|
+
puts "Error when calling BiomarkersApi->biomarkers_biomarker_evidence_by_year_with_http_info: #{e}"
|
|
631
|
+
end
|
|
632
|
+
```
|
|
633
|
+
|
|
634
|
+
### Parameters
|
|
635
|
+
|
|
636
|
+
| Name | Type | Description | Notes |
|
|
637
|
+
| ---- | ---- | ----------- | ----- |
|
|
638
|
+
| **id** | **String** | | |
|
|
639
|
+
| **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
|
|
640
|
+
| **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
|
|
641
|
+
| **sort** | **String** | Comma separated columns, a leading minus for descending: sort=a,-b. | [optional] |
|
|
642
|
+
| **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
|
|
643
|
+
| **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
|
|
644
|
+
|
|
645
|
+
### Return type
|
|
646
|
+
|
|
647
|
+
[**BiomarkerEvidenceByYearResponse**](BiomarkerEvidenceByYearResponse.md)
|
|
648
|
+
|
|
649
|
+
### Authorization
|
|
650
|
+
|
|
651
|
+
[ApiBearerJwt](../README.md#ApiBearerJwt)
|
|
652
|
+
|
|
653
|
+
### HTTP request headers
|
|
654
|
+
|
|
655
|
+
- **Content-Type**: Not defined
|
|
656
|
+
- **Accept**: application/json
|
|
657
|
+
|
|
658
|
+
|
|
418
659
|
## biomarkers_biomarker_literature
|
|
419
660
|
|
|
420
661
|
> <BiomarkerLiteratureResponse> biomarkers_biomarker_literature(id, opts)
|
|
@@ -810,6 +1051,85 @@ end
|
|
|
810
1051
|
- **Accept**: application/json
|
|
811
1052
|
|
|
812
1053
|
|
|
1054
|
+
## biomarkers_biomarker_traversal_status
|
|
1055
|
+
|
|
1056
|
+
> <BiomarkerTraversalStatusResponse> biomarkers_biomarker_traversal_status(id, opts)
|
|
1057
|
+
|
|
1058
|
+
Biomarker coverage by traversal
|
|
1059
|
+
|
|
1060
|
+
### Examples
|
|
1061
|
+
|
|
1062
|
+
```ruby
|
|
1063
|
+
require 'time'
|
|
1064
|
+
require 'pharmaobservatory'
|
|
1065
|
+
# setup authorization
|
|
1066
|
+
PharmaObservatory.configure do |config|
|
|
1067
|
+
# Configure Bearer authorization (JWT): ApiBearerJwt
|
|
1068
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1069
|
+
end
|
|
1070
|
+
|
|
1071
|
+
api_instance = PharmaObservatory::BiomarkersApi.new
|
|
1072
|
+
id = 'ESR1' # String |
|
|
1073
|
+
opts = {
|
|
1074
|
+
cursor: 'cursor_example', # String | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
|
|
1075
|
+
limit: 56, # Integer | Rows per page, up to 500 (default 50).
|
|
1076
|
+
sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
|
|
1077
|
+
group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
|
|
1078
|
+
measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
|
|
1079
|
+
}
|
|
1080
|
+
|
|
1081
|
+
begin
|
|
1082
|
+
# Biomarker coverage by traversal
|
|
1083
|
+
result = api_instance.biomarkers_biomarker_traversal_status(id, opts)
|
|
1084
|
+
p result
|
|
1085
|
+
rescue PharmaObservatory::ApiError => e
|
|
1086
|
+
puts "Error when calling BiomarkersApi->biomarkers_biomarker_traversal_status: #{e}"
|
|
1087
|
+
end
|
|
1088
|
+
```
|
|
1089
|
+
|
|
1090
|
+
#### Using the biomarkers_biomarker_traversal_status_with_http_info variant
|
|
1091
|
+
|
|
1092
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1093
|
+
|
|
1094
|
+
> <Array(<BiomarkerTraversalStatusResponse>, Integer, Hash)> biomarkers_biomarker_traversal_status_with_http_info(id, opts)
|
|
1095
|
+
|
|
1096
|
+
```ruby
|
|
1097
|
+
begin
|
|
1098
|
+
# Biomarker coverage by traversal
|
|
1099
|
+
data, status_code, headers = api_instance.biomarkers_biomarker_traversal_status_with_http_info(id, opts)
|
|
1100
|
+
p status_code # => 2xx
|
|
1101
|
+
p headers # => { ... }
|
|
1102
|
+
p data # => <BiomarkerTraversalStatusResponse>
|
|
1103
|
+
rescue PharmaObservatory::ApiError => e
|
|
1104
|
+
puts "Error when calling BiomarkersApi->biomarkers_biomarker_traversal_status_with_http_info: #{e}"
|
|
1105
|
+
end
|
|
1106
|
+
```
|
|
1107
|
+
|
|
1108
|
+
### Parameters
|
|
1109
|
+
|
|
1110
|
+
| Name | Type | Description | Notes |
|
|
1111
|
+
| ---- | ---- | ----------- | ----- |
|
|
1112
|
+
| **id** | **String** | | |
|
|
1113
|
+
| **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
|
|
1114
|
+
| **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
|
|
1115
|
+
| **sort** | **String** | Comma separated columns, a leading minus for descending: sort=a,-b. | [optional] |
|
|
1116
|
+
| **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
|
|
1117
|
+
| **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
|
|
1118
|
+
|
|
1119
|
+
### Return type
|
|
1120
|
+
|
|
1121
|
+
[**BiomarkerTraversalStatusResponse**](BiomarkerTraversalStatusResponse.md)
|
|
1122
|
+
|
|
1123
|
+
### Authorization
|
|
1124
|
+
|
|
1125
|
+
[ApiBearerJwt](../README.md#ApiBearerJwt)
|
|
1126
|
+
|
|
1127
|
+
### HTTP request headers
|
|
1128
|
+
|
|
1129
|
+
- **Content-Type**: Not defined
|
|
1130
|
+
- **Accept**: application/json
|
|
1131
|
+
|
|
1132
|
+
|
|
813
1133
|
## biomarkers_biomarker_validation
|
|
814
1134
|
|
|
815
1135
|
> <BiomarkerValidationResponse> biomarkers_biomarker_validation(id, opts)
|