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
data/docs/TrialEnrollmentRateRow.md ADDED
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::TrialEnrollmentRateRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **trial_id** | **String** | The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
8
+ | **phase** | **String** | The registry's phase code. | [optional] |
9
+ | **lead_sponsor_name** | **String** | The lead sponsor name as filed. | [optional] |
10
+ | **overall_status_summary** | **String** | A coarse status label (Completed and so on). | [optional] |
11
+ | **actual_enrollment** | **Integer** | Enrollment typed ACTUAL. | [optional] |
12
+ | **enrollment_type** | **String** | ACTUAL or ESTIMATED. | [optional] |
13
+ | **enrollment_is_plausible** | **Boolean** | False when the registered enrollment is a placeholder value rather than a count. | [optional] |
14
+ | **active_sites** | **Integer** | Number of sites the rate is computed over. | [optional] |
15
+ | **facility_country_count** | **Integer** | Number of countries with a listed site. | [optional] |
16
+ | **has_us_facility** | **Boolean** | Whether any listed site is in the United States. | [optional] |
17
+ | **start_date** | **Date** | Trial start date. | [optional] |
18
+ | **primary_completion_date** | **Date** | Primary completion date. | [optional] |
19
+ | **completion_date** | **Date** | Completion date. | [optional] |
20
+ | **primary_completion_date_type** | **String** | ACTUAL or ESTIMATED. | [optional] |
21
+ | **completion_date_type** | **String** | ACTUAL or ESTIMATED. | [optional] |
22
+ | **is_rate_computable** | **Boolean** | Whether the inputs support a rate. | [optional] |
23
+ | **rate_flag_reason** | **String** | Why a rate could not be computed (null when it could). | [optional] |
24
+ | **duration_months** | **Float** | Months from start to primary completion. | [optional] |
25
+ | **duration_months_overall** | **Float** | Months from start to completion. | [optional] |
26
+ | **pts_per_month** | **Float** | Participants enrolled per month. | [optional] |
27
+ | **pts_per_site_month** | **Float** | Participants enrolled per site per month. | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'pharmaobservatory'
33
+
34
+ instance = PharmaObservatory::TrialEnrollmentRateRow.new(
35
+ trial_id: null,
36
+ phase: null,
37
+ lead_sponsor_name: null,
38
+ overall_status_summary: null,
39
+ actual_enrollment: null,
40
+ enrollment_type: null,
41
+ enrollment_is_plausible: null,
42
+ active_sites: null,
43
+ facility_country_count: null,
44
+ has_us_facility: null,
45
+ start_date: null,
46
+ primary_completion_date: null,
47
+ completion_date: null,
48
+ primary_completion_date_type: null,
49
+ completion_date_type: null,
50
+ is_rate_computable: null,
51
+ rate_flag_reason: null,
52
+ duration_months: null,
53
+ duration_months_overall: null,
54
+ pts_per_month: null,
55
+ pts_per_site_month: null
56
+ )
57
+ ```
58
+
data/docs/TrialExtractedEndpointsResponse.md ADDED
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::TrialExtractedEndpointsResponse
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<TrialExtractedEndpointsRow>**](TrialExtractedEndpointsRow.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::TrialExtractedEndpointsResponse.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
+
data/docs/TrialExtractedEndpointsRow.md ADDED
@@ -0,0 +1,40 @@
1
+ # PharmaObservatory::TrialExtractedEndpointsRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **trial_id** | **String** | The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
8
+ | **result_reported** | **Boolean** | Whether the extraction found a formal primary-endpoint result. | [optional] |
9
+ | **signal** | **String** | The extracted reading, verbatim: met, missed, mixed, reported_indeterminate or not_reported. | [optional] |
10
+ | **outcome_category** | **String** | The signal grouped as met, missed, mixed or unclear. | [optional] |
11
+ | **has_clean_outcome** | **Boolean** | Whether outcome_category is met, missed or mixed. | [optional] |
12
+ | **primary_endpoints** | **Array<String>** | The primary endpoint descriptions the extraction found. | [optional] |
13
+ | **primary_endpoint_count** | **Integer** | Number of primary endpoints extracted. | [optional] |
14
+ | **confidence** | **Float** | The extraction's confidence, from 0 to 1. | [optional] |
15
+ | **evidence_quote** | **String** | The text quoted as evidence for the reading. | [optional] |
16
+ | **source_url** | **String** | The registry page the reading was taken from. | [optional] |
17
+ | **model** | **String** | The model that produced the reading. | [optional] |
18
+ | **extracted_at** | **Time** | When the extraction ran. | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'pharmaobservatory'
24
+
25
+ instance = PharmaObservatory::TrialExtractedEndpointsRow.new(
26
+ trial_id: null,
27
+ result_reported: null,
28
+ signal: null,
29
+ outcome_category: null,
30
+ has_clean_outcome: null,
31
+ primary_endpoints: null,
32
+ primary_endpoint_count: null,
33
+ confidence: null,
34
+ evidence_quote: null,
35
+ source_url: null,
36
+ model: null,
37
+ extracted_at: null
38
+ )
39
+ ```
40
+
data/docs/TrialOutcomeMeasuresResponse.md ADDED
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::TrialOutcomeMeasuresResponse
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<TrialOutcomeMeasuresRow>**](TrialOutcomeMeasuresRow.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::TrialOutcomeMeasuresResponse.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
+
data/docs/TrialOutcomeMeasuresRow.md ADDED
@@ -0,0 +1,28 @@
1
+ # PharmaObservatory::TrialOutcomeMeasuresRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **trial_id** | **String** | The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
8
+ | **outcome_id** | **Integer** | The outcome measure's registry id. | [optional] |
9
+ | **outcome_type** | **String** | PRIMARY, SECONDARY or OTHER. | [optional] |
10
+ | **title** | **String** | The outcome measure's title. | [optional] |
11
+ | **time_frame** | **String** | The time frame the measure covers. | [optional] |
12
+ | **population** | **String** | The population the measure is reported for. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'pharmaobservatory'
18
+
19
+ instance = PharmaObservatory::TrialOutcomeMeasuresRow.new(
20
+ trial_id: null,
21
+ outcome_id: null,
22
+ outcome_type: null,
23
+ title: null,
24
+ time_frame: null,
25
+ population: null
26
+ )
27
+ ```
28
+
data/docs/TrialSitesResponse.md ADDED
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::TrialSitesResponse
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<TrialSitesRow>**](TrialSitesRow.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::TrialSitesResponse.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
+
data/docs/TrialSitesRow.md ADDED
@@ -0,0 +1,46 @@
1
+ # PharmaObservatory::TrialSitesRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **trial_id** | **String** | The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
8
+ | **site_key** | **String** | A site key built from the normalized facility name, city, state and country. | [optional] |
9
+ | **listing_ordinal** | **Integer** | 1 for the first listing of the site on the trial; higher for a repeat listing of the same site on the same trial. | [optional] |
10
+ | **facility_name** | **String** | The facility name as filed. | [optional] |
11
+ | **city** | **String** | City. | [optional] |
12
+ | **state** | **String** | State or region. | [optional] |
13
+ | **country** | **String** | Country. | [optional] |
14
+ | **postal** | **String** | Postal code. | [optional] |
15
+ | **latitude** | **Float** | Latitude of the site, in degrees. | [optional] |
16
+ | **longitude** | **Float** | Longitude of the site, in degrees. | [optional] |
17
+ | **geo_precision** | **String** | How exact the coordinate is (postal, city and so on). | [optional] |
18
+ | **coord_source** | **String** | Where the coordinate came from: aact, geonames or als. | [optional] |
19
+ | **trial_status** | **String** | The trial's overall status code. | [optional] |
20
+ | **trial_start_year** | **Integer** | Year the trial started. | [optional] |
21
+ | **trial_title** | **String** | The trial's brief title. | [optional] |
22
+
23
+ ## Example
24
+
25
+ ```ruby
26
+ require 'pharmaobservatory'
27
+
28
+ instance = PharmaObservatory::TrialSitesRow.new(
29
+ trial_id: null,
30
+ site_key: null,
31
+ listing_ordinal: null,
32
+ facility_name: null,
33
+ city: null,
34
+ state: null,
35
+ country: null,
36
+ postal: null,
37
+ latitude: null,
38
+ longitude: null,
39
+ geo_precision: null,
40
+ coord_source: null,
41
+ trial_status: null,
42
+ trial_start_year: null,
43
+ trial_title: null
44
+ )
45
+ ```
46
+