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.
Files changed (175) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +101 -4
  3. data/docs/BiomarkerBqpAssertionsRow.md +1 -1
  4. data/docs/BiomarkerEvidenceRow.md +1 -1
  5. data/docs/BiomarkerLiteratureRow.md +1 -1
  6. data/docs/BiomarkerRelationsResponse.md +58 -0
  7. data/docs/BiomarkerRelationsRow.md +54 -0
  8. data/docs/BiomarkerSampleCoverageResponse.md +58 -0
  9. data/docs/BiomarkerSampleCoverageRow.md +36 -0
  10. data/docs/BiomarkerSamplePrevalenceResponse.md +58 -0
  11. data/docs/BiomarkerSamplePrevalenceRow.md +56 -0
  12. data/docs/BiomarkerValidationResponse.md +58 -0
  13. data/docs/BiomarkerValidationRow.md +70 -0
  14. data/docs/BiomarkersApi.md +320 -0
  15. data/docs/BiomarkersRow.md +2 -2
  16. data/docs/CellLinesRow.md +1 -1
  17. data/docs/CompaniesApi.md +410 -0
  18. data/docs/CompaniesRecord.md +1 -1
  19. data/docs/CompaniesRecordAttributes.md +18 -0
  20. data/docs/CompaniesRow.md +7 -3
  21. data/docs/CompanyAssetsResponse.md +58 -0
  22. data/docs/CompanyAssetsRow.md +42 -0
  23. data/docs/CompanyFundingEventsResponse.md +58 -0
  24. data/docs/CompanyFundingEventsRow.md +62 -0
  25. data/docs/CompanyFundingSummaryResponse.md +58 -0
  26. data/docs/CompanyFundingSummaryRow.md +46 -0
  27. data/docs/CompanyProgramsRow.md +2 -2
  28. data/docs/ConditionAdverseEventsResponse.md +58 -0
  29. data/docs/ConditionAdverseEventsRow.md +24 -0
  30. data/docs/ConditionBurdenResponse.md +58 -0
  31. data/docs/ConditionBurdenRow.md +32 -0
  32. data/docs/ConditionDeliveryResponse.md +58 -0
  33. data/docs/ConditionDeliveryRow.md +44 -0
  34. data/docs/ConditionDrugsResponse.md +58 -0
  35. data/docs/ConditionDrugsRow.md +26 -0
  36. data/docs/ConditionPrevalenceResponse.md +58 -0
  37. data/docs/ConditionPrevalenceRow.md +62 -0
  38. data/docs/ConditionPublicationsResponse.md +58 -0
  39. data/docs/ConditionPublicationsRow.md +32 -0
  40. data/docs/ConditionSitesResponse.md +58 -0
  41. data/docs/ConditionSitesRow.md +28 -0
  42. data/docs/ConditionTrialsResponse.md +58 -0
  43. data/docs/ConditionTrialsRow.md +58 -0
  44. data/docs/ConditionsApi.md +953 -0
  45. data/docs/ConditionsRecord.md +38 -0
  46. data/docs/ConditionsRecordAttributes.md +20 -0
  47. data/docs/ConditionsResponse.md +58 -0
  48. data/docs/ConditionsRow.md +32 -0
  49. data/docs/DrugPatentCliffRow.md +1 -1
  50. data/docs/InstitutionalHoldingsRow.md +3 -1
  51. data/docs/LegalEntitiesApi.md +160 -0
  52. data/docs/LegalEntitiesRow.md +1 -1
  53. data/docs/OwnershipPositionsResponse.md +58 -0
  54. data/docs/OwnershipPositionsRow.md +100 -0
  55. data/docs/PdufaDatesRow.md +2 -2
  56. data/docs/SiteCroTrialsRow.md +1 -1
  57. data/docs/SiteTrialConditionsRow.md +1 -1
  58. data/docs/SiteTrialDrugsRow.md +1 -1
  59. data/docs/SiteTrialsRow.md +1 -1
  60. data/docs/SponsorRecruitmentByPhaseRow.md +2 -2
  61. data/docs/SponsorRecruitmentDurationRow.md +1 -1
  62. data/docs/SponsorTrialsRow.md +2 -2
  63. data/docs/TrialAdverseEventsResponse.md +58 -0
  64. data/docs/TrialAdverseEventsRow.md +28 -0
  65. data/docs/TrialChangesResponse.md +58 -0
  66. data/docs/TrialChangesRow.md +36 -0
  67. data/docs/TrialDeliveryResponse.md +58 -0
  68. data/docs/TrialDeliveryRow.md +64 -0
  69. data/docs/TrialDemographicsResponse.md +58 -0
  70. data/docs/TrialDemographicsRow.md +32 -0
  71. data/docs/TrialDrugsResponse.md +58 -0
  72. data/docs/TrialDrugsRow.md +30 -0
  73. data/docs/TrialEnrollmentHistoryResponse.md +58 -0
  74. data/docs/TrialEnrollmentHistoryRow.md +36 -0
  75. data/docs/TrialEnrollmentRateResponse.md +58 -0
  76. data/docs/TrialEnrollmentRateRow.md +58 -0
  77. data/docs/TrialExtractedEndpointsResponse.md +58 -0
  78. data/docs/TrialExtractedEndpointsRow.md +40 -0
  79. data/docs/TrialOutcomeMeasuresResponse.md +58 -0
  80. data/docs/TrialOutcomeMeasuresRow.md +28 -0
  81. data/docs/TrialSitesResponse.md +58 -0
  82. data/docs/TrialSitesRow.md +46 -0
  83. data/docs/TrialsApi.md +1033 -0
  84. data/docs/TrialsRecord.md +38 -0
  85. data/docs/TrialsRecordAttributes.md +24 -0
  86. data/docs/TrialsResponse.md +58 -0
  87. data/docs/TrialsRow.md +116 -0
  88. data/lib/pharmaobservatory/api/biomarkers_api.rb +336 -0
  89. data/lib/pharmaobservatory/api/companies_api.rb +455 -0
  90. data/lib/pharmaobservatory/api/conditions_api.rb +1001 -0
  91. data/lib/pharmaobservatory/api/legal_entities_api.rb +168 -0
  92. data/lib/pharmaobservatory/api/trials_api.rb +1085 -0
  93. data/lib/pharmaobservatory/models/biomarker_bqp_assertions_row.rb +1 -1
  94. data/lib/pharmaobservatory/models/biomarker_evidence_row.rb +1 -1
  95. data/lib/pharmaobservatory/models/biomarker_literature_row.rb +1 -1
  96. data/lib/pharmaobservatory/models/biomarker_relations_response.rb +478 -0
  97. data/lib/pharmaobservatory/models/biomarker_relations_row.rb +421 -0
  98. data/lib/pharmaobservatory/models/biomarker_sample_coverage_response.rb +478 -0
  99. data/lib/pharmaobservatory/models/biomarker_sample_coverage_row.rb +322 -0
  100. data/lib/pharmaobservatory/models/biomarker_sample_prevalence_response.rb +478 -0
  101. data/lib/pharmaobservatory/models/biomarker_sample_prevalence_row.rb +436 -0
  102. data/lib/pharmaobservatory/models/biomarker_validation_response.rb +478 -0
  103. data/lib/pharmaobservatory/models/biomarker_validation_row.rb +509 -0
  104. data/lib/pharmaobservatory/models/biomarkers_row.rb +2 -2
  105. data/lib/pharmaobservatory/models/cell_lines_row.rb +1 -1
  106. data/lib/pharmaobservatory/models/companies_record.rb +1 -1
  107. data/lib/pharmaobservatory/models/companies_record_attributes.rb +220 -0
  108. data/lib/pharmaobservatory/models/companies_row.rb +29 -7
  109. data/lib/pharmaobservatory/models/company_assets_response.rb +478 -0
  110. data/lib/pharmaobservatory/models/company_assets_row.rb +355 -0
  111. data/lib/pharmaobservatory/models/company_funding_events_response.rb +478 -0
  112. data/lib/pharmaobservatory/models/company_funding_events_row.rb +465 -0
  113. data/lib/pharmaobservatory/models/company_funding_summary_response.rb +478 -0
  114. data/lib/pharmaobservatory/models/company_funding_summary_row.rb +377 -0
  115. data/lib/pharmaobservatory/models/company_programs_row.rb +2 -2
  116. data/lib/pharmaobservatory/models/condition_adverse_events_response.rb +478 -0
  117. data/lib/pharmaobservatory/models/condition_adverse_events_row.rb +256 -0
  118. data/lib/pharmaobservatory/models/condition_burden_response.rb +478 -0
  119. data/lib/pharmaobservatory/models/condition_burden_row.rb +300 -0
  120. data/lib/pharmaobservatory/models/condition_delivery_response.rb +478 -0
  121. data/lib/pharmaobservatory/models/condition_delivery_row.rb +366 -0
  122. data/lib/pharmaobservatory/models/condition_drugs_response.rb +478 -0
  123. data/lib/pharmaobservatory/models/condition_drugs_row.rb +267 -0
  124. data/lib/pharmaobservatory/models/condition_prevalence_response.rb +478 -0
  125. data/lib/pharmaobservatory/models/condition_prevalence_row.rb +465 -0
  126. data/lib/pharmaobservatory/models/condition_publications_response.rb +478 -0
  127. data/lib/pharmaobservatory/models/condition_publications_row.rb +300 -0
  128. data/lib/pharmaobservatory/models/condition_sites_response.rb +478 -0
  129. data/lib/pharmaobservatory/models/condition_sites_row.rb +278 -0
  130. data/lib/pharmaobservatory/models/condition_trials_response.rb +478 -0
  131. data/lib/pharmaobservatory/models/condition_trials_row.rb +443 -0
  132. data/lib/pharmaobservatory/models/conditions_record.rb +385 -0
  133. data/lib/pharmaobservatory/models/conditions_record_attributes.rb +229 -0
  134. data/lib/pharmaobservatory/models/conditions_response.rb +478 -0
  135. data/lib/pharmaobservatory/models/conditions_row.rb +304 -0
  136. data/lib/pharmaobservatory/models/drug_patent_cliff_row.rb +1 -1
  137. data/lib/pharmaobservatory/models/institutional_holdings_row.rb +13 -2
  138. data/lib/pharmaobservatory/models/legal_entities_row.rb +1 -1
  139. data/lib/pharmaobservatory/models/ownership_positions_response.rb +478 -0
  140. data/lib/pharmaobservatory/models/ownership_positions_row.rb +674 -0
  141. data/lib/pharmaobservatory/models/pdufa_dates_row.rb +2 -2
  142. data/lib/pharmaobservatory/models/site_cro_trials_row.rb +1 -1
  143. data/lib/pharmaobservatory/models/site_trial_conditions_row.rb +1 -1
  144. data/lib/pharmaobservatory/models/site_trial_drugs_row.rb +1 -1
  145. data/lib/pharmaobservatory/models/site_trials_row.rb +1 -1
  146. data/lib/pharmaobservatory/models/sponsor_recruitment_by_phase_row.rb +2 -2
  147. data/lib/pharmaobservatory/models/sponsor_recruitment_duration_row.rb +1 -1
  148. data/lib/pharmaobservatory/models/sponsor_trials_row.rb +2 -2
  149. data/lib/pharmaobservatory/models/trial_adverse_events_response.rb +478 -0
  150. data/lib/pharmaobservatory/models/trial_adverse_events_row.rb +278 -0
  151. data/lib/pharmaobservatory/models/trial_changes_response.rb +478 -0
  152. data/lib/pharmaobservatory/models/trial_changes_row.rb +328 -0
  153. data/lib/pharmaobservatory/models/trial_delivery_response.rb +478 -0
  154. data/lib/pharmaobservatory/models/trial_delivery_row.rb +476 -0
  155. data/lib/pharmaobservatory/models/trial_demographics_response.rb +478 -0
  156. data/lib/pharmaobservatory/models/trial_demographics_row.rb +300 -0
  157. data/lib/pharmaobservatory/models/trial_drugs_response.rb +478 -0
  158. data/lib/pharmaobservatory/models/trial_drugs_row.rb +291 -0
  159. data/lib/pharmaobservatory/models/trial_enrollment_history_response.rb +478 -0
  160. data/lib/pharmaobservatory/models/trial_enrollment_history_row.rb +322 -0
  161. data/lib/pharmaobservatory/models/trial_enrollment_rate_response.rb +478 -0
  162. data/lib/pharmaobservatory/models/trial_enrollment_rate_row.rb +443 -0
  163. data/lib/pharmaobservatory/models/trial_extracted_endpoints_response.rb +478 -0
  164. data/lib/pharmaobservatory/models/trial_extracted_endpoints_row.rb +346 -0
  165. data/lib/pharmaobservatory/models/trial_outcome_measures_response.rb +478 -0
  166. data/lib/pharmaobservatory/models/trial_outcome_measures_row.rb +278 -0
  167. data/lib/pharmaobservatory/models/trial_sites_response.rb +478 -0
  168. data/lib/pharmaobservatory/models/trial_sites_row.rb +377 -0
  169. data/lib/pharmaobservatory/models/trials_record.rb +385 -0
  170. data/lib/pharmaobservatory/models/trials_record_attributes.rb +247 -0
  171. data/lib/pharmaobservatory/models/trials_response.rb +478 -0
  172. data/lib/pharmaobservatory/models/trials_row.rb +784 -0
  173. data/lib/pharmaobservatory/version.rb +1 -1
  174. data/lib/pharmaobservatory.rb +63 -0
  175. metadata +127 -1
@@ -0,0 +1,62 @@
1
+ # PharmaObservatory::CompanyFundingEventsRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **funding_event_id** | **String** | The funding event key. | [optional] |
8
+ | **issuer_name** | **String** | The issuer's name as filed. | [optional] |
9
+ | **issuer_org_id** | **String** | Legal-entity level: the issuer's organization record. | [optional] |
10
+ | **issuer_company_id** | **String** | Company level: the issuer's company (null when the issuer did not resolve to a company). | [optional] |
11
+ | **issuer_company_name** | **String** | Display name of the issuer's company. | [optional] |
12
+ | **issuer_group_id** | **String** | Group level: the issuer's current ultimate parent company; a root company's group is itself. | [optional] |
13
+ | **issuer_group_name** | **String** | Display name of the issuer's group. | [optional] |
14
+ | **event_date** | **Date** | The date the source gives for the event; event_stage says what the date means. | [optional] |
15
+ | **fiscal_year** | **Integer** | The NIH fiscal year, for a grant; null for the other sources. | [optional] |
16
+ | **source** | **String** | The source lane: reporter (NIH RePORTER grants), form_d (SEC Form D Regulation D offerings), edgar_offerings (SEC registered offerings) or sec_extracted (financings extracted from SEC filings). | [optional] |
17
+ | **round_type** | **String** | The kind of round (for example grant_nih, sbir, reg_d_private, ipo, follow_on, public_offering, atm, registered_direct, debt). | [optional] |
18
+ | **round_subtype** | **String** | A finer type, such as the grant activity code, the Regulation D exemption or the SEC form. | [optional] |
19
+ | **is_dilutive** | **Boolean** | Whether the round dilutes existing equity; null where the instrument is not classified. | [optional] |
20
+ | **amount_usd** | **Float** | The disclosed amount in whole US dollars; null where the amount is not disclosed. | [optional] |
21
+ | **currency** | **String** | The currency the source reports the amount in. | [optional] |
22
+ | **amount_is_disclosed** | **Boolean** | Whether the source states an amount for the event. | [optional] |
23
+ | **capital_treatment** | **String** | Whether the event's dollars count as capital raised, and if not why not (for example structured_source, actual_inflow, capacity, committed). | [optional] |
24
+ | **is_actual_issuer_inflow** | **Boolean** | True where the event counts as capital the issuer raised. | [optional] |
25
+ | **event_stage** | **String** | The lifecycle stage the event's date refers to (for example sold_to_date, funded, closed, registered, announced). | [optional] |
26
+ | **administering_ic** | **String** | The National Institutes of Health institute or center that administers the grant (for example CA for the National Cancer Institute); null for the other sources. | [optional] |
27
+ | **n_awards** | **Integer** | Grant applications folded into the event; 1 for the other sources. | [optional] |
28
+ | **cumulative_raised_usd** | **Float** | The running total of disclosed amounts over the company's own events up to and including this one, in date order; null where the event has no company. | [optional] |
29
+ | **source_url** | **String** | Link to the filing the event was read from, where the source has one. | [optional] |
30
+
31
+ ## Example
32
+
33
+ ```ruby
34
+ require 'pharmaobservatory'
35
+
36
+ instance = PharmaObservatory::CompanyFundingEventsRow.new(
37
+ funding_event_id: null,
38
+ issuer_name: null,
39
+ issuer_org_id: null,
40
+ issuer_company_id: null,
41
+ issuer_company_name: null,
42
+ issuer_group_id: null,
43
+ issuer_group_name: null,
44
+ event_date: null,
45
+ fiscal_year: null,
46
+ source: null,
47
+ round_type: null,
48
+ round_subtype: null,
49
+ is_dilutive: null,
50
+ amount_usd: null,
51
+ currency: null,
52
+ amount_is_disclosed: null,
53
+ capital_treatment: null,
54
+ is_actual_issuer_inflow: null,
55
+ event_stage: null,
56
+ administering_ic: null,
57
+ n_awards: null,
58
+ cumulative_raised_usd: null,
59
+ source_url: null
60
+ )
61
+ ```
62
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::CompanyFundingSummaryResponse
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<CompanyFundingSummaryRow>**](CompanyFundingSummaryRow.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::CompanyFundingSummaryResponse.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,46 @@
1
+ # PharmaObservatory::CompanyFundingSummaryRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **company_id** | **String** | The company key (company:<key>). | [optional] |
8
+ | **company_name** | **String** | Display name of the company. | [optional] |
9
+ | **group_id** | **String** | Group level: the current ultimate parent company; a root company's group is itself. | [optional] |
10
+ | **group_name** | **String** | Display name of the group. | [optional] |
11
+ | **n_rounds** | **Integer** | Funding events of the company, disclosed or not. | [optional] |
12
+ | **total_non_dilutive_usd** | **Float** | Disclosed non-dilutive amounts (grants, debt, royalty and similar), in whole US dollars. | [optional] |
13
+ | **total_dilutive_usd** | **Float** | Disclosed dilutive amounts (equity-issuing rounds), in whole US dollars. | [optional] |
14
+ | **total_unclassified_usd** | **Float** | Disclosed amounts of events whose instrument is not classified, kept apart from the other two totals. | [optional] |
15
+ | **n_unclassified_rounds** | **Integer** | Events whose instrument is not classified. | [optional] |
16
+ | **total_raised_usd** | **Float** | All disclosed amounts, the sum of the three totals, in whole US dollars. | [optional] |
17
+ | **first_funded_date** | **Date** | Date of the earliest event. | [optional] |
18
+ | **last_funded_date** | **Date** | Date of the latest event. | [optional] |
19
+ | **latest_round_type** | **String** | The round type of the latest event. | [optional] |
20
+ | **latest_round_date** | **Date** | The date of the latest event. | [optional] |
21
+ | **stage_label** | **String** | A coarse reading of the round types: public, growth_private, seed_private, unclassified or non_dilutive_only. | [optional] |
22
+
23
+ ## Example
24
+
25
+ ```ruby
26
+ require 'pharmaobservatory'
27
+
28
+ instance = PharmaObservatory::CompanyFundingSummaryRow.new(
29
+ company_id: null,
30
+ company_name: null,
31
+ group_id: null,
32
+ group_name: null,
33
+ n_rounds: null,
34
+ total_non_dilutive_usd: null,
35
+ total_dilutive_usd: null,
36
+ total_unclassified_usd: null,
37
+ n_unclassified_rounds: null,
38
+ total_raised_usd: null,
39
+ first_funded_date: null,
40
+ last_funded_date: null,
41
+ latest_round_type: null,
42
+ latest_round_date: null,
43
+ stage_label: null
44
+ )
45
+ ```
46
+
@@ -12,7 +12,7 @@
12
12
  | **sponsor_group_name** | **String** | Display name of the sponsor's group. | [optional] |
13
13
  | **drug_id** | **String** | The drug key. | [optional] |
14
14
  | **drug_name** | **String** | The drug's name. | [optional] |
15
- | **condition_id** | **String** | The condition key (UMLS CUI). | [optional] |
15
+ | **condition_id** | **String** | The condition key, a MeSH (Medical Subject Headings) descriptor id (D followed by six to nine digits). | [optional] |
16
16
  | **condition_name** | **String** | The condition's name. | [optional] |
17
17
  | **max_phase** | **Integer** | Highest phase reached: 0 early phase 1 through 6 for phase 4 (marketed); -1 when unstated. | [optional] |
18
18
  | **n_trials** | **Integer** | Lead-sponsored trials in the program. | [optional] |
@@ -20,7 +20,7 @@
20
20
  | **last_year** | **Integer** | Latest trial start year. | [optional] |
21
21
  | **withdrawn** | **Boolean** | True when the drug has been withdrawn. | [optional] |
22
22
  | **lifecycle** | **String** | approved, active or abandoned. | [optional] |
23
- | **dalys_millions** | **Float** | Disability-adjusted life years (millions) of the condition's global burden, IHME GBD 2021. Null for a caller without the licence for this column; see withheld_columns. | [optional] |
23
+ | **dalys_millions** | **Float** | Disability-adjusted life years (DALYs, millions) of the condition's global burden, from the Global Burden of Disease (GBD) 2021 study of the Institute for Health Metrics and Evaluation (IHME). Null for a caller without the licence for this column; see withheld_columns. | [optional] |
24
24
 
25
25
  ## Example
26
26
 
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::ConditionAdverseEventsResponse
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<ConditionAdverseEventsRow>**](ConditionAdverseEventsRow.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::ConditionAdverseEventsResponse.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,24 @@
1
+ # PharmaObservatory::ConditionAdverseEventsRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **condition_id** | **String** | The condition key, a MeSH (Medical Subject Headings) descriptor id (D followed by six to nine digits). | [optional] |
8
+ | **adverse_event_term** | **String** | The adverse event term as the trials report it. | [optional] |
9
+ | **subjects_affected** | **Float** | Subjects affected, summed across the condition's trials. | [optional] |
10
+ | **n_trials** | **Integer** | Trials for this condition that report the term. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'pharmaobservatory'
16
+
17
+ instance = PharmaObservatory::ConditionAdverseEventsRow.new(
18
+ condition_id: null,
19
+ adverse_event_term: null,
20
+ subjects_affected: null,
21
+ n_trials: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::ConditionBurdenResponse
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<ConditionBurdenRow>**](ConditionBurdenRow.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::ConditionBurdenResponse.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,32 @@
1
+ # PharmaObservatory::ConditionBurdenRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **condition_id** | **String** | The condition key, a MeSH (Medical Subject Headings) descriptor id (D followed by six to nine digits). | [optional] |
8
+ | **condition_name** | **String** | The condition's MeSH heading. | [optional] |
9
+ | **cause_name** | **String** | The Global Burden of Disease cause matched to the condition. | [optional] |
10
+ | **dalys_millions** | **Float** | Global disability-adjusted life years for the matched cause, in millions. | [optional] |
11
+ | **deaths_millions** | **Float** | Global deaths for the matched cause, in millions. | [optional] |
12
+ | **druggability** | **Integer** | Druggability class of the matched cause: 1 highly druggable, 2 druggable, 3 challenging, 4 very challenging. | [optional] |
13
+ | **n_trials** | **Integer** | Trials for the condition, counted under each condition they are tagged with and each condition above it in the MeSH tree. | [optional] |
14
+ | **trials_per_million_dalys** | **Float** | Trials per million DALYs: n_trials divided by dalys_millions. | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'pharmaobservatory'
20
+
21
+ instance = PharmaObservatory::ConditionBurdenRow.new(
22
+ condition_id: null,
23
+ condition_name: null,
24
+ cause_name: null,
25
+ dalys_millions: null,
26
+ deaths_millions: null,
27
+ druggability: null,
28
+ n_trials: null,
29
+ trials_per_million_dalys: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::ConditionDeliveryResponse
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<ConditionDeliveryRow>**](ConditionDeliveryRow.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::ConditionDeliveryResponse.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,44 @@
1
+ # PharmaObservatory::ConditionDeliveryRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **condition_id** | **String** | The condition key, a MeSH (Medical Subject Headings) descriptor id (D followed by six to nine digits). | [optional] |
8
+ | **condition_name** | **String** | The condition's MeSH heading. | [optional] |
9
+ | **n_trials** | **Integer** | Trials in the roll-up, counted under each condition they are tagged with and each condition above it in the MeSH tree. | [optional] |
10
+ | **n_trials_with_observed_plan** | **Integer** | Trials whose first recorded plan is known. | [optional] |
11
+ | **n_trials_with_enrollment_delta** | **Integer** | Trials graded on enrollment. | [optional] |
12
+ | **n_trials_with_completion_delta** | **Integer** | Trials graded on completion date. | [optional] |
13
+ | **n_enrollment_met** | **Integer** | Graded trials that met their planned enrollment. | [optional] |
14
+ | **n_enrollment_missed** | **Integer** | Graded trials that missed their planned enrollment. | [optional] |
15
+ | **enrollment_hit_rate** | **Float** | Share of graded trials that met planned enrollment (0 to 1). | [optional] |
16
+ | **median_enrollment_attainment_pct** | **Float** | Median enrollment attained as a percent of the plan. | [optional] |
17
+ | **n_on_time** | **Integer** | Graded trials that completed on or before the planned date. | [optional] |
18
+ | **n_slipped** | **Integer** | Graded trials that completed after the planned date. | [optional] |
19
+ | **on_time_rate** | **Float** | Share of graded trials that completed on time (0 to 1). | [optional] |
20
+ | **median_completion_slip_days** | **Float** | Median days between planned and actual primary completion, among graded trials; negative when earlier than planned. | [optional] |
21
+
22
+ ## Example
23
+
24
+ ```ruby
25
+ require 'pharmaobservatory'
26
+
27
+ instance = PharmaObservatory::ConditionDeliveryRow.new(
28
+ condition_id: null,
29
+ condition_name: null,
30
+ n_trials: null,
31
+ n_trials_with_observed_plan: null,
32
+ n_trials_with_enrollment_delta: null,
33
+ n_trials_with_completion_delta: null,
34
+ n_enrollment_met: null,
35
+ n_enrollment_missed: null,
36
+ enrollment_hit_rate: null,
37
+ median_enrollment_attainment_pct: null,
38
+ n_on_time: null,
39
+ n_slipped: null,
40
+ on_time_rate: null,
41
+ median_completion_slip_days: null
42
+ )
43
+ ```
44
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::ConditionDrugsResponse
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<ConditionDrugsRow>**](ConditionDrugsRow.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::ConditionDrugsResponse.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,26 @@
1
+ # PharmaObservatory::ConditionDrugsRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **condition_id** | **String** | The condition key, a MeSH (Medical Subject Headings) descriptor id (D followed by six to nine digits). | [optional] |
8
+ | **drug_id** | **String** | The drug key (a canonical drug id; the same value as molecule_id on this dataset). | [optional] |
9
+ | **molecule_id** | **String** | The molecule key the drug resolves to. | [optional] |
10
+ | **drug_name** | **String** | The molecule's display name. | [optional] |
11
+ | **n_trials** | **Integer** | Trials for this condition that test the molecule. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'pharmaobservatory'
17
+
18
+ instance = PharmaObservatory::ConditionDrugsRow.new(
19
+ condition_id: null,
20
+ drug_id: null,
21
+ molecule_id: null,
22
+ drug_name: null,
23
+ n_trials: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::ConditionPrevalenceResponse
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<ConditionPrevalenceRow>**](ConditionPrevalenceRow.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::ConditionPrevalenceResponse.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
+