pharmaobservatory 0.1.1 → 0.1.3

data/docs/SitesRecord.md

@@ -0,0 +1,38 @@
+# PharmaObservatory::SitesRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object_type** | **String** |  |  |
+| **id** | **String** |  |  |
+| **record** | [**SitesRow**](SitesRow.md) |  |  |
+| **attributes** | [**SitesRecordAttributes**](SitesRecordAttributes.md) |  | [optional] |
+| **datasets** | [**Array<DatasetListing>**](DatasetListing.md) |  |  |
+| **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **freshness** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::SitesRecord.new(
+  object_type: null,
+  id: null,
+  record: null,
+  attributes: null,
+  datasets: null,
+  attribution: null,
+  source_credit: null,
+  freshness: null,
+  build: null,
+  build_state: null,
+  restriction: null
+)
+```
+

data/docs/SitesRecordAttributes.md

@@ -0,0 +1,18 @@
+# PharmaObservatory::SitesRecordAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **site_hospitals** | [**SiteHospitalsRow**](SiteHospitalsRow.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::SitesRecordAttributes.new(
+  site_hospitals: null
+)
+```
+

data/docs/SitesResponse.md

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

data/docs/SitesRow.md

@@ -0,0 +1,54 @@
+# PharmaObservatory::SitesRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **site_id** | **String** | The site key: one facility spelling from the registry; the id the site page address carries. | [optional] |
+| **site_name** | **String** | The facility name as filed in the registry. | [optional] |
+| **city** | **String** | City as filed. | [optional] |
+| **state** | **String** | State or province as filed. | [optional] |
+| **country** | **String** | Country name as filed. | [optional] |
+| **latitude** | **Float** | Latitude of the finest coordinate the record has. | [optional] |
+| **longitude** | **Float** | Longitude of the finest coordinate the record has. | [optional] |
+| **geo_precision** | **String** | How finely the coordinate places the site (city, postal and so on). | [optional] |
+| **coord_source** | **String** | The source of the coordinate: aact (the registry's own), geonames (GeoNames) or als (Amazon Location Service). | [optional] |
+| **is_location_source_asserted_only** | **Boolean** | True when the city the registry gave is a location that only the registry asserts for the institution. | [optional] |
+| **site_org_id** | **String** | Legal-entity level: the organization record the site's institution resolved to (null when unresolved). | [optional] |
+| **site_company_id** | **String** | Company level: the company the site's institution belongs to (null when unresolved). | [optional] |
+| **site_company_name** | **String** | Display name of the site's institution's company. | [optional] |
+| **site_group_id** | **String** | Group level: the site's institution's current ultimate parent company; a root company's group is itself. | [optional] |
+| **site_group_name** | **String** | Display name of the site's institution's group. | [optional] |
+| **n_trials** | **Integer** | Registered trials that list the site. | [optional] |
+| **n_active** | **Integer** | Those trials whose status is ongoing. | [optional] |
+| **first_year** | **Integer** | Year of the earliest trial start at the site. | [optional] |
+| **last_year** | **Integer** | Year of the latest trial start at the site. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::SitesRow.new(
+  site_id: null,
+  site_name: null,
+  city: null,
+  state: null,
+  country: null,
+  latitude: null,
+  longitude: null,
+  geo_precision: null,
+  coord_source: null,
+  is_location_source_asserted_only: null,
+  site_org_id: null,
+  site_company_id: null,
+  site_company_name: null,
+  site_group_id: null,
+  site_group_name: null,
+  n_trials: null,
+  n_active: null,
+  first_year: null,
+  last_year: null
+)
+```
+

data/docs/SponsorRecruitmentByPhaseResponse.md

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

data/docs/SponsorRecruitmentByPhaseRow.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::SponsorRecruitmentByPhaseRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sponsor_org_id** | **String** | Legal-entity level: the organization record the series is for (the lead sponsor). | [optional] |
+| **sponsor_name** | **String** | Display name of the organization record. | [optional] |
+| **sponsor_company_id** | **String** | Company level: the company the organization belongs to (null when unresolved). | [optional] |
+| **sponsor_company_name** | **String** | Display name of the sponsor's company. | [optional] |
+| **sponsor_group_id** | **String** | Group level: the sponsor's current ultimate parent company; a root company's group is itself. | [optional] |
+| **sponsor_group_name** | **String** | Display name of the sponsor's group. | [optional] |
+| **phase_bucket** | **String** | The phase bucket of the trial (one vocabulary for predicted and realized rows). | [optional] |
+| **n_predicted_open** | **Integer** | Per phase bucket, the same count as the series column of that name. | [optional] |
+| **n_predicted_at_cap** | **Integer** | Per phase bucket, the same count as the series column of that name. | [optional] |
+| **n_predicted_overdue** | **Integer** | Per phase bucket, the same count as the series column of that name. | [optional] |
+| **predicted_months_median** | **Float** | Median over the bucket's rows; NULL under min_n. | [optional] |
+| **baseline_months_median** | **Float** | Median over the bucket's rows; NULL under min_n. | [optional] |
+| **n_realized** | **Integer** | Per phase bucket, the same count as the series column of that name. | [optional] |
+| **realized_months_median** | **Float** | Median over the bucket's rows; NULL under min_n. | [optional] |
+| **error_phase_mae_months** | **Float** | Backtest mean absolute error in months for this phase bucket; NULL on an unmeasured bucket or one with no open predicted trial. | [optional] |
+| **error_phase_relmae_vs_baseline** | **Float** | The model MAE over the baseline MAE in this phase bucket. | [optional] |
+| **error_phase_baseline_mae_months** | **Float** | The baseline MAE in months in this phase bucket. | [optional] |
+| **error_phase_n_trials** | **Integer** | Backtest trials behind the phase figure. | [optional] |
+| **error_phase_n_years** | **Integer** | Backtest years behind the phase figure. | [optional] |
+| **min_n** | **Integer** | The floor applied: a median is withheld below this many trials, carried so a reader sees the floor used. | [optional] |
+| **training_cutoff** | **Date** | The date the model's training data ends. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::SponsorRecruitmentByPhaseRow.new(
+  sponsor_org_id: null,
+  sponsor_name: null,
+  sponsor_company_id: null,
+  sponsor_company_name: null,
+  sponsor_group_id: null,
+  sponsor_group_name: null,
+  phase_bucket: null,
+  n_predicted_open: null,
+  n_predicted_at_cap: null,
+  n_predicted_overdue: null,
+  predicted_months_median: null,
+  baseline_months_median: null,
+  n_realized: null,
+  realized_months_median: null,
+  error_phase_mae_months: null,
+  error_phase_relmae_vs_baseline: null,
+  error_phase_baseline_mae_months: null,
+  error_phase_n_trials: null,
+  error_phase_n_years: null,
+  min_n: null,
+  training_cutoff: null
+)
+```
+

data/docs/SponsorRecruitmentDurationResponse.md

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

data/docs/SponsorRecruitmentDurationRow.md

@@ -0,0 +1,94 @@
+# PharmaObservatory::SponsorRecruitmentDurationRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sponsor_org_id** | **String** | Legal-entity level: the organization record the series is for (the lead sponsor). | [optional] |
+| **sponsor_name** | **String** | Display name of the organization record. | [optional] |
+| **sponsor_company_id** | **String** | Company level: the company the organization belongs to (null when unresolved). | [optional] |
+| **sponsor_company_name** | **String** | Display name of the sponsor's company. | [optional] |
+| **sponsor_group_id** | **String** | Group level: the sponsor's current ultimate parent company; a root company's group is itself. | [optional] |
+| **sponsor_group_name** | **String** | Display name of the sponsor's group. | [optional] |
+| **n_trials_in_series** | **Integer** | Trials the organization leads. | [optional] |
+| **n_evaluated** | **Integer** | Of those, trials with a row in the per-trial predictions at the cutoff. | [optional] |
+| **n_not_evaluated** | **Integer** | n_trials_in_series - n_evaluated: registered after the cutoff or a coverage gap; the data cannot tell which. | [optional] |
+| **n_out_of_population** | **Integer** | Evaluated trials with prediction_status out_of_population. | [optional] |
+| **n_completed** | **Integer** | Evaluated trials with prediction_status completed. | [optional] |
+| **n_stopped** | **Integer** | Evaluated trials with prediction_status stopped. | [optional] |
+| **n_no_registration_record** | **Integer** | Evaluated trials with prediction_status no_registration_record. | [optional] |
+| **n_retrospective_registration** | **Integer** | Evaluated trials with prediction_status retrospective_registration. | [optional] |
+| **n_start_not_actual** | **Integer** | Evaluated trials with prediction_status start_not_actual. | [optional] |
+| **n_fit_failed** | **Integer** | Evaluated trials with prediction_status fit_failed. | [optional] |
+| **n_predicted** | **Integer** | Evaluated trials with prediction_status predicted, superseded or not. | [optional] |
+| **n_predicted_superseded** | **Integer** | Predicted trials whose CURRENT record shows the outcome (COMPLETED, TERMINATED, WITHDRAWN or an ACTUAL primary completion); kept out of every predicted figure, as the trial page withholds them. | [optional] |
+| **n_predicted_open** | **Integer** | n_predicted - n_predicted_superseded; the denominator of every predicted figure. | [optional] |
+| **n_predicted_at_cap** | **Integer** | Open predicted trials whose figure sits at the horizon cap (an at-cap row contributes the cap to the median). | [optional] |
+| **n_predicted_overdue** | **Integer** | Open predicted trials running past their predicted end at the cutoff. | [optional] |
+| **n_predicted_error_measured** | **Integer** | Open predicted trials in a phase bucket the backtest measured (error_phase_mae_months not null). | [optional] |
+| **predicted_months_median** | **Float** | Median of the carried predicted months over open predicted trials (capped at horizon_cap_months). NULL under min_n. | [optional] |
+| **predicted_months_p25** | **Float** | 25th percentile, same rows and floor. | [optional] |
+| **predicted_months_p75** | **Float** | 75th percentile, same rows and floor. | [optional] |
+| **baseline_months_median** | **Float** | Median of the carried baseline months over the same open predicted trials. NULL under min_n. | [optional] |
+| **n_realized** | **Integer** | Trials with a registered span (primary completion typed ACTUAL today, plausible start and completion), from the realized-duration input. | [optional] |
+| **realized_months_median** | **Float** | Median registered start to primary completion in months over n_realized trials. NULL under min_n. | [optional] |
+| **realized_months_p25** | **Float** | 25th percentile, same rows and floor. | [optional] |
+| **realized_months_p75** | **Float** | 75th percentile, same rows and floor. | [optional] |
+| **n_realized_over_cap** | **Integer** | Realized spans above horizon_cap_months, so a reader sees how many would have hit the cap. | [optional] |
+| **min_n** | **Integer** | The floor applied: a median is withheld below this many trials, carried so a reader sees the floor used. | [optional] |
+| **rollup_status** | **String** | rolled_up (open predicted >= min_n), below_floor (1 <= open < min_n, counts only), none_predicted (evaluated, no open prediction), none_evaluated. | [optional] |
+| **realized_status** | **String** | rolled_up (n_realized >= min_n), below_floor, or none. | [optional] |
+| **training_cutoff** | **Date** | The date the model's training data ends. | [optional] |
+| **model_name** | **String** | The recruitment-duration model. | [optional] |
+| **model_version** | **String** | The model version. | [optional] |
+| **horizon_cap_months** | **Integer** | The cap on predicted months (36 today), from the prediction rows. | [optional] |
+| **method** | **String** | The run's method sentence from the run provenance, never re-authored. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::SponsorRecruitmentDurationRow.new(
+  sponsor_org_id: null,
+  sponsor_name: null,
+  sponsor_company_id: null,
+  sponsor_company_name: null,
+  sponsor_group_id: null,
+  sponsor_group_name: null,
+  n_trials_in_series: null,
+  n_evaluated: null,
+  n_not_evaluated: null,
+  n_out_of_population: null,
+  n_completed: null,
+  n_stopped: null,
+  n_no_registration_record: null,
+  n_retrospective_registration: null,
+  n_start_not_actual: null,
+  n_fit_failed: null,
+  n_predicted: null,
+  n_predicted_superseded: null,
+  n_predicted_open: null,
+  n_predicted_at_cap: null,
+  n_predicted_overdue: null,
+  n_predicted_error_measured: null,
+  predicted_months_median: null,
+  predicted_months_p25: null,
+  predicted_months_p75: null,
+  baseline_months_median: null,
+  n_realized: null,
+  realized_months_median: null,
+  realized_months_p25: null,
+  realized_months_p75: null,
+  n_realized_over_cap: null,
+  min_n: null,
+  rollup_status: null,
+  realized_status: null,
+  training_cutoff: null,
+  model_name: null,
+  model_version: null,
+  horizon_cap_months: null,
+  method: null
+)
+```
+

data/docs/SponsorTrialStartForecastResponse.md

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

data/docs/SponsorTrialStartForecastRow.md

@@ -0,0 +1,70 @@
+# PharmaObservatory::SponsorTrialStartForecastRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sponsor_org_id** | **String** | Legal-entity level: the organization record the forecast series is for. | [optional] |
+| **sponsor_name** | **String** | Display name of the organization record. | [optional] |
+| **sponsor_company_id** | **String** | Company level: the company the organization belongs to (null when unresolved). | [optional] |
+| **sponsor_company_name** | **String** | Display name of the sponsor's company. | [optional] |
+| **sponsor_group_id** | **String** | Group level: the sponsor's current ultimate parent company; a root company's group is itself. | [optional] |
+| **sponsor_group_name** | **String** | Display name of the sponsor's group. | [optional] |
+| **target_year** | **Integer** | The calendar year forecast. | [optional] |
+| **horizon_offset** | **Integer** | Years ahead of the build year (0 is the current year). | [optional] |
+| **months_observed** | **Integer** | Months of the target year already observed. | [optional] |
+| **months_forecast** | **Integer** | Months of the target year forecast. | [optional] |
+| **input_observed_through_cutoff** | **Integer** | Trials started in the target year up to the training cutoff. | [optional] |
+| **input_planned_remaining** | **Integer** | Trials registered as planned to start in the rest of the target year. | [optional] |
+| **forecast_point** | **Float** | The forecast trial starts for the whole target year. A forecast of the eventual count, never an actual count, and it carries no interval. | [optional] |
+| **forecast_status** | **String** | The series' forecast status. | [optional] |
+| **input_trials_window_60m** | **Integer** | Trials the organization started in the last 60 months. | [optional] |
+| **input_starts_per_year_60m** | **Float** | Average trial starts per year over the last 60 months. | [optional] |
+| **size_bucket** | **String** | The series size bucket the backtest error is measured in. | [optional] |
+| **backtest_horizon** | **String** | The horizon the backtest error was measured at. | [optional] |
+| **backtest_smape_pct** | **Float** | Backtest symmetric mean absolute percentage error. | [optional] |
+| **backtest_rel_bias** | **Float** | Backtest relative bias. | [optional] |
+| **backtest_relmae_vs_snaive** | **Float** | Backtest mean absolute error relative to the seasonal naive baseline. | [optional] |
+| **backtest_n_series** | **Integer** | Series the backtest covered. | [optional] |
+| **backtest_ref** | **String** | The backtest run reference. | [optional] |
+| **model_name** | **String** | The forecasting model. | [optional] |
+| **model_version** | **String** | The model version. | [optional] |
+| **training_cutoff** | **Date** | The date the model's training data ends. | [optional] |
+| **method** | **String** | How the forecast was produced. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::SponsorTrialStartForecastRow.new(
+  sponsor_org_id: null,
+  sponsor_name: null,
+  sponsor_company_id: null,
+  sponsor_company_name: null,
+  sponsor_group_id: null,
+  sponsor_group_name: null,
+  target_year: null,
+  horizon_offset: null,
+  months_observed: null,
+  months_forecast: null,
+  input_observed_through_cutoff: null,
+  input_planned_remaining: null,
+  forecast_point: null,
+  forecast_status: null,
+  input_trials_window_60m: null,
+  input_starts_per_year_60m: null,
+  size_bucket: null,
+  backtest_horizon: null,
+  backtest_smape_pct: null,
+  backtest_rel_bias: null,
+  backtest_relmae_vs_snaive: null,
+  backtest_n_series: null,
+  backtest_ref: null,
+  model_name: null,
+  model_version: null,
+  training_cutoff: null,
+  method: null
+)
+```
+

data/docs/SponsorTrialsResponse.md

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