pharmaobservatory 0.1.11 → 0.1.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +17 -6
- data/docs/CompaniesApi.md +332 -4
- data/docs/CompaniesRecordAttributes.md +2 -0
- data/docs/CompaniesRow.md +1 -1
- data/docs/CompanyAssetsRow.md +5 -1
- data/docs/CompanyCompetitorsRow.md +8 -2
- data/docs/CompanyCosponsorsResponse.md +58 -0
- data/docs/CompanyCosponsorsRow.md +58 -0
- data/docs/CompanyPeerProfileResponse.md +58 -0
- data/docs/CompanyPeerProfileRow.md +60 -0
- data/docs/CompanyPeersResponse.md +58 -0
- data/docs/CompanyPeersRow.md +54 -0
- data/docs/CompanyProgramsRow.md +4 -0
- data/docs/InvestorPortfolioRow.md +41 -11
- data/docs/InvestorsApi.md +4 -4
- data/docs/InvestorsRow.md +3 -1
- data/docs/LegalEntitiesApi.md +80 -0
- data/docs/ProgramLicensingCandidatesRow.md +4 -0
- data/lib/pharmaobservatory/api/companies_api.rb +366 -2
- data/lib/pharmaobservatory/api/investors_api.rb +2 -2
- data/lib/pharmaobservatory/api/legal_entities_api.rb +84 -0
- data/lib/pharmaobservatory/models/companies_record_attributes.rb +10 -1
- data/lib/pharmaobservatory/models/companies_row.rb +1 -1
- data/lib/pharmaobservatory/models/company_assets_row.rb +27 -5
- data/lib/pharmaobservatory/models/company_competitors_row.rb +40 -7
- data/lib/pharmaobservatory/models/company_cosponsors_response.rb +478 -0
- data/lib/pharmaobservatory/models/company_cosponsors_row.rb +445 -0
- data/lib/pharmaobservatory/models/company_peer_profile_response.rb +478 -0
- data/lib/pharmaobservatory/models/company_peer_profile_row.rb +454 -0
- data/lib/pharmaobservatory/models/company_peers_response.rb +478 -0
- data/lib/pharmaobservatory/models/company_peers_row.rb +421 -0
- data/lib/pharmaobservatory/models/company_programs_row.rb +23 -1
- data/lib/pharmaobservatory/models/investor_portfolio_row.rb +180 -13
- data/lib/pharmaobservatory/models/investors_row.rb +13 -2
- data/lib/pharmaobservatory/models/program_licensing_candidates_row.rb +23 -1
- data/lib/pharmaobservatory/version.rb +1 -1
- data/lib/pharmaobservatory.rb +6 -0
- metadata +14 -2
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# PharmaObservatory::CompanyCosponsorsRow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **company_id** | **String** | Company level: the company the row is about; the entry key for the companies object type. | [optional] |
|
|
8
|
+
| **company_name** | **String** | Display name of the company. | [optional] |
|
|
9
|
+
| **group_id** | **String** | Group level: the company's current ultimate parent; a root's group is itself. | [optional] |
|
|
10
|
+
| **group_name** | **String** | Display name of the group. | [optional] |
|
|
11
|
+
| **row_level** | **String** | root: the co-sponsor's ultimate parent company, with the distinct trials any company of that root shares with this company. member: a company under that root that itself co-sponsored, with its own count. Filter on one level; the two do not add. | [optional] |
|
|
12
|
+
| **cosponsor_company_id** | **String** | Company level: the co-sponsoring company. At row_level root this is the root company; at member it is the member company itself. | [optional] |
|
|
13
|
+
| **cosponsor_company_name** | **String** | Display name of the co-sponsoring company. | [optional] |
|
|
14
|
+
| **cosponsor_group_id** | **String** | Group level: the co-sponsor's current ultimate parent; a root's group is itself. | [optional] |
|
|
15
|
+
| **cosponsor_group_name** | **String** | Display name of the co-sponsor's group. | [optional] |
|
|
16
|
+
| **cosponsor_root_id** | **String** | The ultimate parent company of the co-sponsor, the ladder company's `coalesce(ultimate_parent_company_id, company_id)`. Equal to cosponsor_company_id at row_level root, and the root a member row sits under. | [optional] |
|
|
17
|
+
| **cosponsor_rank** | **Integer** | The rank of the ROOT among this company's co-sponsor roots by distinct shared trials (1 is the most; ties broken by root id). The same on a root row and on each of its member rows. | [optional] |
|
|
18
|
+
| **member_rank** | **Integer** | 0 on a root row; 1 and up on the member rows of that root, by the member's own shared trials. Order by cosponsor_rank then member_rank to list each root followed by its members. | [optional] |
|
|
19
|
+
| **n_members** | **Integer** | Member companies of this root that co-sponsored with this company, before the member cut. The same on a root row and its member rows. | [optional] |
|
|
20
|
+
| **n_candidates** | **Integer** | Distinct co-sponsor roots for this company before the top-25 cut; the same on every row of a company. | [optional] |
|
|
21
|
+
| **n_shared_trials** | **Integer** | Distinct trials that name both. At row_level root, the distinct trials of any company under the root (never a sum over members); at member, that company's own trials. | [optional] |
|
|
22
|
+
| **n_trials_company_lead** | **Integer** | Of the shared trials, those where an organization record of this company holds the ClinicalTrials.gov lead sponsor role. At most n_shared_trials; it may overlap n_trials_cosponsor_lead. | [optional] |
|
|
23
|
+
| **n_trials_cosponsor_lead** | **Integer** | Of the shared trials, those where the co-sponsor's organization record holds the lead sponsor role. At most n_shared_trials. | [optional] |
|
|
24
|
+
| **first_shared_start_year** | **Integer** | The earliest registered start year over the shared trials; null when none has a plausible year. | [optional] |
|
|
25
|
+
| **last_shared_start_year** | **Integer** | The latest registered start year over the shared trials; null when none has a plausible year. | [optional] |
|
|
26
|
+
| **n_shared_conditions** | **Integer** | Distinct specific MeSH disease areas over the shared trials. | [optional] |
|
|
27
|
+
| **top_shared_conditions** | **Array<String>** | Up to 5 MeSH disease names by shared-trial count then name. An empty list when none. | [optional] |
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
```ruby
|
|
32
|
+
require 'pharmaobservatory'
|
|
33
|
+
|
|
34
|
+
instance = PharmaObservatory::CompanyCosponsorsRow.new(
|
|
35
|
+
company_id: null,
|
|
36
|
+
company_name: null,
|
|
37
|
+
group_id: null,
|
|
38
|
+
group_name: null,
|
|
39
|
+
row_level: null,
|
|
40
|
+
cosponsor_company_id: null,
|
|
41
|
+
cosponsor_company_name: null,
|
|
42
|
+
cosponsor_group_id: null,
|
|
43
|
+
cosponsor_group_name: null,
|
|
44
|
+
cosponsor_root_id: null,
|
|
45
|
+
cosponsor_rank: null,
|
|
46
|
+
member_rank: null,
|
|
47
|
+
n_members: null,
|
|
48
|
+
n_candidates: null,
|
|
49
|
+
n_shared_trials: null,
|
|
50
|
+
n_trials_company_lead: null,
|
|
51
|
+
n_trials_cosponsor_lead: null,
|
|
52
|
+
first_shared_start_year: null,
|
|
53
|
+
last_shared_start_year: null,
|
|
54
|
+
n_shared_conditions: null,
|
|
55
|
+
top_shared_conditions: null
|
|
56
|
+
)
|
|
57
|
+
```
|
|
58
|
+
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# PharmaObservatory::CompanyPeerProfileResponse
|
|
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** | [**AnimalWelfareAssurancesResponseScope**](AnimalWelfareAssurancesResponseScope.md) | | [optional] |
|
|
12
|
+
| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) | | |
|
|
13
|
+
| **rows** | [**Array<CompanyPeerProfileRow>**](CompanyPeerProfileRow.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** | [**AnimalWelfareAssurancesResponseFreshness**](AnimalWelfareAssurancesResponseFreshness.md) | | [optional] |
|
|
25
|
+
| **build** | [**AnimalWelfareAssurancesResponseBuild**](AnimalWelfareAssurancesResponseBuild.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::CompanyPeerProfileResponse.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,60 @@
|
|
|
1
|
+
# PharmaObservatory::CompanyPeerProfileRow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **company_id** | **String** | Company level: the company the row is about; the entry key for the companies object type. | [optional] |
|
|
8
|
+
| **company_name** | **String** | Display name of the company. | [optional] |
|
|
9
|
+
| **group_id** | **String** | Group level: the company's current ultimate parent; a root's group is itself. | [optional] |
|
|
10
|
+
| **group_name** | **String** | Display name of the group. | [optional] |
|
|
11
|
+
| **peer_state** | **String** | measured when the company has at least one peer; no_live_owned_program when it has no live owned program; phase_not_reported when its live owned programs carry no phase; no_candidates when stage and modality are known and no other company shares them. | [optional] |
|
|
12
|
+
| **n_live_owned_programs** | **Integer** | Distinct live owned (drug, condition) programs of the company's subtree. | [optional] |
|
|
13
|
+
| **n_live_owned_drugs** | **Integer** | Distinct live owned drugs of the company's subtree. | [optional] |
|
|
14
|
+
| **lead_stage** | **String** | Furthest phase of the live owned programs: approved, phase3, phase2 (Phase 2/3 included), phase1 (Phase 1/2 included) or early_phase1. Null when no program carries a phase. | [optional] |
|
|
15
|
+
| **lead_max_phase** | **Integer** | The phase code behind lead_stage: 6 Phase 4 or approved, 5 Phase 3, 4 Phase 2/3, 3 Phase 2, 2 Phase 1/2, 1 Phase 1, 0 Early Phase 1. | [optional] |
|
|
16
|
+
| **lead_drug_id** | **String** | The canonical drug id of the lead drug, the highest-phase live owned drug (ties: most trials, then drug id). | [optional] |
|
|
17
|
+
| **lead_drug_name** | **String** | Name of the lead drug. | [optional] |
|
|
18
|
+
| **n_biologic_drugs** | **Integer** | Live owned drugs whose GSRS substance type is protein or nucleic acid. | [optional] |
|
|
19
|
+
| **biologic_share** | **Float** | n_biologic_drugs over n_live_owned_drugs, 0 to 1. Null when the company has no live owned drug. | [optional] |
|
|
20
|
+
| **modality_band** | **String** | biologic when biologic_share is at least 0.5, else non_biologic. | [optional] |
|
|
21
|
+
| **primary_area** | **String** | MeSH top-level category with the most live owned program trials. | [optional] |
|
|
22
|
+
| **primary_area_trials** | **Integer** | Live owned program trials in primary_area. | [optional] |
|
|
23
|
+
| **num_lead_trials** | **Integer** | Distinct lead-sponsored trials of the company's subtree. | [optional] |
|
|
24
|
+
| **size_band** | **String** | Band of num_lead_trials: 1-4, 5-19, 20-99 or 100+. | [optional] |
|
|
25
|
+
| **n_cell_candidates** | **Integer** | Other measured companies outside the company's group that share stage, modality, area and size (match level 1), before the top 10 are kept. | [optional] |
|
|
26
|
+
| **n_peers** | **Integer** | Peer rows kept for the company, at most 10. | [optional] |
|
|
27
|
+
| **coverage_measured** | **Integer** | Companies in this dataset with peer_state measured. The same value on every row. | [optional] |
|
|
28
|
+
| **coverage_total** | **Integer** | Companies in this dataset. The same value on every row. | [optional] |
|
|
29
|
+
|
|
30
|
+
## Example
|
|
31
|
+
|
|
32
|
+
```ruby
|
|
33
|
+
require 'pharmaobservatory'
|
|
34
|
+
|
|
35
|
+
instance = PharmaObservatory::CompanyPeerProfileRow.new(
|
|
36
|
+
company_id: null,
|
|
37
|
+
company_name: null,
|
|
38
|
+
group_id: null,
|
|
39
|
+
group_name: null,
|
|
40
|
+
peer_state: null,
|
|
41
|
+
n_live_owned_programs: null,
|
|
42
|
+
n_live_owned_drugs: null,
|
|
43
|
+
lead_stage: null,
|
|
44
|
+
lead_max_phase: null,
|
|
45
|
+
lead_drug_id: null,
|
|
46
|
+
lead_drug_name: null,
|
|
47
|
+
n_biologic_drugs: null,
|
|
48
|
+
biologic_share: null,
|
|
49
|
+
modality_band: null,
|
|
50
|
+
primary_area: null,
|
|
51
|
+
primary_area_trials: null,
|
|
52
|
+
num_lead_trials: null,
|
|
53
|
+
size_band: null,
|
|
54
|
+
n_cell_candidates: null,
|
|
55
|
+
n_peers: null,
|
|
56
|
+
coverage_measured: null,
|
|
57
|
+
coverage_total: null
|
|
58
|
+
)
|
|
59
|
+
```
|
|
60
|
+
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# PharmaObservatory::CompanyPeersResponse
|
|
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** | [**AnimalWelfareAssurancesResponseScope**](AnimalWelfareAssurancesResponseScope.md) | | [optional] |
|
|
12
|
+
| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) | | |
|
|
13
|
+
| **rows** | [**Array<CompanyPeersRow>**](CompanyPeersRow.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** | [**AnimalWelfareAssurancesResponseFreshness**](AnimalWelfareAssurancesResponseFreshness.md) | | [optional] |
|
|
25
|
+
| **build** | [**AnimalWelfareAssurancesResponseBuild**](AnimalWelfareAssurancesResponseBuild.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::CompanyPeersResponse.new(
|
|
35
|
+
dataset: null,
|
|
36
|
+
grain: null,
|
|
37
|
+
object_type: null,
|
|
38
|
+
id: null,
|
|
39
|
+
scope: null,
|
|
40
|
+
columns: null,
|
|
41
|
+
rows: null,
|
|
42
|
+
total: null,
|
|
43
|
+
next_cursor: null,
|
|
44
|
+
sort: null,
|
|
45
|
+
filters: null,
|
|
46
|
+
group_by: null,
|
|
47
|
+
measures: null,
|
|
48
|
+
attribution: null,
|
|
49
|
+
source_credit: null,
|
|
50
|
+
withheld_tiers: null,
|
|
51
|
+
withheld_columns: null,
|
|
52
|
+
freshness: null,
|
|
53
|
+
build: null,
|
|
54
|
+
build_state: null,
|
|
55
|
+
restriction: null
|
|
56
|
+
)
|
|
57
|
+
```
|
|
58
|
+
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# PharmaObservatory::CompanyPeersRow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **company_id** | **String** | Company level: the company the row is about; the entry key for the companies object type. | [optional] |
|
|
8
|
+
| **company_name** | **String** | Display name of the company. | [optional] |
|
|
9
|
+
| **group_id** | **String** | Group level: the company's current ultimate parent; a root's group is itself. | [optional] |
|
|
10
|
+
| **group_name** | **String** | Display name of the group. | [optional] |
|
|
11
|
+
| **peer_company_id** | **String** | Company level: the peer company. | [optional] |
|
|
12
|
+
| **peer_company_name** | **String** | Display name of the peer company. | [optional] |
|
|
13
|
+
| **peer_group_id** | **String** | Group level: the peer's current ultimate parent; a root's group is itself. | [optional] |
|
|
14
|
+
| **peer_group_name** | **String** | Display name of the peer's group. | [optional] |
|
|
15
|
+
| **peer_rank** | **Integer** | The peer's rank for the company, 1 is the closest match: match_level first, then the closeness of lead-trial counts, then of biologic share. Dense 1 to N. | [optional] |
|
|
16
|
+
| **match_level** | **Integer** | What the peer matched the company on. 1 stage, modality, area and size; 2 stage, modality and area; 3 stage, modality and size; 4 stage and modality. Stage and modality always match. | [optional] |
|
|
17
|
+
| **matched_area** | **Boolean** | True when the peer shares the company's primary therapeutic area. | [optional] |
|
|
18
|
+
| **matched_size** | **Boolean** | True when the peer shares the company's size band. | [optional] |
|
|
19
|
+
| **lead_stage** | **String** | The peer's lead stage, the furthest phase of its live owned programs. Equal to the company's lead stage on every row. | [optional] |
|
|
20
|
+
| **lead_drug_name** | **String** | The peer's lead drug, the highest-phase live owned drug (ties: most trials). | [optional] |
|
|
21
|
+
| **biologic_share** | **Float** | Share, 0 to 1, of the peer's live owned drugs that are biologic (GSRS protein or nucleic acid substance type). | [optional] |
|
|
22
|
+
| **modality_band** | **String** | biologic when biologic_share is at least 0.5, else non_biologic. Equal to the company's band on every row. | [optional] |
|
|
23
|
+
| **primary_area** | **String** | The peer's primary therapeutic area: the MeSH top-level category with the most live owned program trials. | [optional] |
|
|
24
|
+
| **num_lead_trials** | **Integer** | Distinct lead-sponsored trials of the peer's subtree. | [optional] |
|
|
25
|
+
| **size_band** | **String** | Band of num_lead_trials: 1-4, 5-19, 20-99 or 100+. | [optional] |
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
require 'pharmaobservatory'
|
|
31
|
+
|
|
32
|
+
instance = PharmaObservatory::CompanyPeersRow.new(
|
|
33
|
+
company_id: null,
|
|
34
|
+
company_name: null,
|
|
35
|
+
group_id: null,
|
|
36
|
+
group_name: null,
|
|
37
|
+
peer_company_id: null,
|
|
38
|
+
peer_company_name: null,
|
|
39
|
+
peer_group_id: null,
|
|
40
|
+
peer_group_name: null,
|
|
41
|
+
peer_rank: null,
|
|
42
|
+
match_level: null,
|
|
43
|
+
matched_area: null,
|
|
44
|
+
matched_size: null,
|
|
45
|
+
lead_stage: null,
|
|
46
|
+
lead_drug_name: null,
|
|
47
|
+
biologic_share: null,
|
|
48
|
+
modality_band: null,
|
|
49
|
+
primary_area: null,
|
|
50
|
+
num_lead_trials: null,
|
|
51
|
+
size_band: null
|
|
52
|
+
)
|
|
53
|
+
```
|
|
54
|
+
|
data/docs/CompanyProgramsRow.md
CHANGED
|
@@ -20,6 +20,8 @@
|
|
|
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
|
+
| **owned** | **Boolean** | True when the sponsor is judged to develop the drug (an experimental arm, a regulatory holder, or an inferred lead); false when it is the backbone or comparator of a combination, one of many leads of a crowded drug, or not the holder of a generic. Every row is kept; this column labels it. | [optional] |
|
|
24
|
+
| **ownership_basis** | **String** | Why owned is what it is: experimental_arm, regulatory_holder or inferred_lead (owned), or backbone, comparator, crowded_not_lead or generic_not_holder (not owned). inferred_lead is an inference made where the trials give no arm evidence either way. | [optional] |
|
|
23
25
|
| **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
26
|
|
|
25
27
|
## Example
|
|
@@ -44,6 +46,8 @@ instance = PharmaObservatory::CompanyProgramsRow.new(
|
|
|
44
46
|
last_year: null,
|
|
45
47
|
withdrawn: null,
|
|
46
48
|
lifecycle: null,
|
|
49
|
+
owned: null,
|
|
50
|
+
ownership_basis: null,
|
|
47
51
|
dalys_millions: null
|
|
48
52
|
)
|
|
49
53
|
```
|
|
@@ -5,17 +5,32 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **investor_id** | **String** | The investor key. | [optional] |
|
|
8
|
-
| **
|
|
9
|
-
| **
|
|
10
|
-
| **
|
|
11
|
-
| **
|
|
12
|
-
| **
|
|
13
|
-
| **
|
|
14
|
-
| **
|
|
15
|
-
| **
|
|
16
|
-
| **
|
|
17
|
-
| **
|
|
18
|
-
| **
|
|
8
|
+
| **company_key** | **String** | The company's key on this dataset: its organization id where it resolves, else the SEC CIK, else investor_site: followed by the normalized name as printed on the investor's page. | [optional] |
|
|
9
|
+
| **company_key_kind** | **String** | What company_key is: org, cik or investor_site. | [optional] |
|
|
10
|
+
| **sources** | **Array<String>** | Where the row comes from: sec_edgar (S-1 and 424B holder tables), investor_site (the investor's own portfolio page), or both. | [optional] |
|
|
11
|
+
| **issuer_cik** | **String** | The issuer's SEC Central Index Key (CIK), ten digits. Null for a row only the investor's website names. | [optional] |
|
|
12
|
+
| **issuer_name** | **String** | The company's name: its organization record's name, else the SEC company name, else the name as printed on the investor's page. | [optional] |
|
|
13
|
+
| **company_name_as_listed** | **String** | The company's name as printed on the investor's own portfolio page. Null for a row only SEC filings name. | [optional] |
|
|
14
|
+
| **company_website_url** | **String** | The company's website as linked on the investor's own portfolio page. Null when the page gave none. | [optional] |
|
|
15
|
+
| **issuer_org_id** | **String** | Legal-entity level: the company's organization record (null when unresolved). | [optional] |
|
|
16
|
+
| **issuer_company_id** | **String** | Company level: the company's record (null when unresolved). | [optional] |
|
|
17
|
+
| **issuer_company_name** | **String** | Display name of the company. | [optional] |
|
|
18
|
+
| **issuer_group_id** | **String** | Group level: the company's current ultimate parent; a root's group is itself. | [optional] |
|
|
19
|
+
| **issuer_group_name** | **String** | Display name of the company's group. | [optional] |
|
|
20
|
+
| **relationship_types** | **Array<String>** | How the investor is tied to the company: holder_5pct (a 5 percent holder) or selling_stockholder from filings, and portfolio_listed_current, portfolio_listed_realized, portfolio_listed_exited or portfolio_listed (no status printed) from the investor's own page. | [optional] |
|
|
21
|
+
| **edge_count** | **Integer** | Filing mentions behind the row, across every filing and relationship type. 0 for a row only the investor's website names. | [optional] |
|
|
22
|
+
| **first_observed_date** | **Date** | The earliest filing date the investor was named against the issuer. Null for a row only the investor's website names. | [optional] |
|
|
23
|
+
| **last_observed_date** | **Date** | The latest filing date the investor was named against the issuer. Null for a row only the investor's website names. | [optional] |
|
|
24
|
+
| **listed_from** | **Date** | The retrieval date of the first crawl of the investor's own portfolio page that listed the company (a crawl date, not an investment date). Null for a row only SEC filings name. | [optional] |
|
|
25
|
+
| **listed_to** | **Date** | The retrieval date of the first later crawl that did not list the company, or the date the page went away. Null while the company is still listed, and for a row only SEC filings name. | [optional] |
|
|
26
|
+
| **removal_reason** | **String** | Why listed_to is set: absent_from_later_version (a later crawl of the page omitted the company) or page_gone (the page went away). Null exactly when listed_to is null. | [optional] |
|
|
27
|
+
| **is_removed** | **Boolean** | True when the investor's own page no longer lists the company (listed_to is set). SEC filings do not reopen it. | [optional] |
|
|
28
|
+
| **status_on_page** | **String** | The status the investor's page states for the company, verbatim: current, realized, exited or unknown (the page listed it with no status). Null for a row only SEC filings name. | [optional] |
|
|
29
|
+
| **status_date** | **String** | The date the page itself prints for the status, as printed (for example 2024 or March 2024). Null unless the page printed one. | [optional] |
|
|
30
|
+
| **status_first_observed_at** | **Date** | The date we first saw this status for the company on the investor's page: an observation date, never the date the event happened. | [optional] |
|
|
31
|
+
| **site_evidence_verified** | **Boolean** | True when the quote behind a website listing was found on the investor's page, false when it was not, null when no verification flag was recorded and for a row only SEC filings name. | [optional] |
|
|
32
|
+
| **source_url** | **String** | The address of the investor's portfolio page the listing was read from. Null for a row only SEC filings name. | [optional] |
|
|
33
|
+
| **site_last_retrieved_at** | **Time** | When the investor's portfolio page was last retrieved with the company listed on it, in UTC. | [optional] |
|
|
19
34
|
| **is_life_sciences_issuer** | **Boolean** | True when the issuer's SIC (Standard Industrial Classification) code is a life-sciences code, false when it is another code, null when the issuer has no SIC evidence. | [optional] |
|
|
20
35
|
|
|
21
36
|
## Example
|
|
@@ -25,8 +40,13 @@ require 'pharmaobservatory'
|
|
|
25
40
|
|
|
26
41
|
instance = PharmaObservatory::InvestorPortfolioRow.new(
|
|
27
42
|
investor_id: null,
|
|
43
|
+
company_key: null,
|
|
44
|
+
company_key_kind: null,
|
|
45
|
+
sources: null,
|
|
28
46
|
issuer_cik: null,
|
|
29
47
|
issuer_name: null,
|
|
48
|
+
company_name_as_listed: null,
|
|
49
|
+
company_website_url: null,
|
|
30
50
|
issuer_org_id: null,
|
|
31
51
|
issuer_company_id: null,
|
|
32
52
|
issuer_company_name: null,
|
|
@@ -36,6 +56,16 @@ instance = PharmaObservatory::InvestorPortfolioRow.new(
|
|
|
36
56
|
edge_count: null,
|
|
37
57
|
first_observed_date: null,
|
|
38
58
|
last_observed_date: null,
|
|
59
|
+
listed_from: null,
|
|
60
|
+
listed_to: null,
|
|
61
|
+
removal_reason: null,
|
|
62
|
+
is_removed: null,
|
|
63
|
+
status_on_page: null,
|
|
64
|
+
status_date: null,
|
|
65
|
+
status_first_observed_at: null,
|
|
66
|
+
site_evidence_verified: null,
|
|
67
|
+
source_url: null,
|
|
68
|
+
site_last_retrieved_at: null,
|
|
39
69
|
is_life_sciences_issuer: null
|
|
40
70
|
)
|
|
41
71
|
```
|
data/docs/InvestorsApi.md
CHANGED
|
@@ -7,7 +7,7 @@ All URIs are relative to *https://pharmaobservatory.com*
|
|
|
7
7
|
| [**investors_get**](InvestorsApi.md#investors_get) | **GET** /api/v1/investors/{id} | One investor |
|
|
8
8
|
| [**investors_institutional_holdings**](InvestorsApi.md#investors_institutional_holdings) | **GET** /api/v1/investors/{id}/institutional_holdings | Institutional holdings (SEC Form 13F) |
|
|
9
9
|
| [**investors_investor_funds**](InvestorsApi.md#investors_investor_funds) | **GET** /api/v1/investors/{id}/investor_funds | Investor private funds by type |
|
|
10
|
-
| [**investors_investor_portfolio**](InvestorsApi.md#investors_investor_portfolio) | **GET** /api/v1/investors/{id}/investor_portfolio | Investor portfolio (offering filings) |
|
|
10
|
+
| [**investors_investor_portfolio**](InvestorsApi.md#investors_investor_portfolio) | **GET** /api/v1/investors/{id}/investor_portfolio | Investor portfolio (offering filings and investor websites) |
|
|
11
11
|
| [**investors_investor_private_funds**](InvestorsApi.md#investors_investor_private_funds) | **GET** /api/v1/investors/{id}/investor_private_funds | Investor private funds |
|
|
12
12
|
| [**investors_list**](InvestorsApi.md#investors_list) | **GET** /api/v1/investors | List investors |
|
|
13
13
|
| [**investors_managers**](InvestorsApi.md#investors_managers) | **GET** /api/v1/investors/{id}/managers | Institutional managers (SEC Form 13F) |
|
|
@@ -243,7 +243,7 @@ end
|
|
|
243
243
|
|
|
244
244
|
> <InvestorPortfolioResponse> investors_investor_portfolio(id, opts)
|
|
245
245
|
|
|
246
|
-
Investor portfolio (offering filings)
|
|
246
|
+
Investor portfolio (offering filings and investor websites)
|
|
247
247
|
|
|
248
248
|
### Examples
|
|
249
249
|
|
|
@@ -267,7 +267,7 @@ opts = {
|
|
|
267
267
|
}
|
|
268
268
|
|
|
269
269
|
begin
|
|
270
|
-
# Investor portfolio (offering filings)
|
|
270
|
+
# Investor portfolio (offering filings and investor websites)
|
|
271
271
|
result = api_instance.investors_investor_portfolio(id, opts)
|
|
272
272
|
p result
|
|
273
273
|
rescue PharmaObservatory::ApiError => e
|
|
@@ -283,7 +283,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
283
283
|
|
|
284
284
|
```ruby
|
|
285
285
|
begin
|
|
286
|
-
# Investor portfolio (offering filings)
|
|
286
|
+
# Investor portfolio (offering filings and investor websites)
|
|
287
287
|
data, status_code, headers = api_instance.investors_investor_portfolio_with_http_info(id, opts)
|
|
288
288
|
p status_code # => 2xx
|
|
289
289
|
p headers # => { ... }
|
data/docs/InvestorsRow.md
CHANGED
|
@@ -16,7 +16,8 @@
|
|
|
16
16
|
| **is_life_sciences_focused_basis** | **String** | Where is_life_sciences_focused came from: human or agent (a recorded classification), override (a curator's call), edge_share (the share of its portfolio edges in life-sciences issuers) or classifier (the Form 13F biomedical value share). Null exactly when the flag is null. | [optional] |
|
|
17
17
|
| **private_fund_count** | **Integer** | Private funds the adviser reports on Form ADV Item 7.B. | [optional] |
|
|
18
18
|
| **total_private_fund_gav** | **Float** | The adviser's total private-fund gross asset value (GAV) in whole US dollars, a firm-level figure. | [optional] |
|
|
19
|
-
| **portfolio_co_count** | **Integer** | Distinct portfolio companies named against the investor in S-1 and 424B offering holder tables. 0 usually means no named-holder link was observed. | [optional] |
|
|
19
|
+
| **portfolio_co_count** | **Integer** | Distinct portfolio companies named against the investor in S-1 and 424B offering holder tables or listed on the investor's own portfolio page, not marked removed there. 0 usually means no named-holder link or website listing was observed. | [optional] |
|
|
20
|
+
| **portfolio_co_removed_count** | **Integer** | Distinct portfolio companies the investor's own portfolio page listed in an earlier crawl and no longer lists. portfolio_co_count and this count sum to the investor's rows in investor_portfolio. | [optional] |
|
|
20
21
|
| **holdings_position_count** | **Integer** | Current Form 13F positions reported by the managers that resolve to this investor, summed over its manager keys. 0 when none resolves. | [optional] |
|
|
21
22
|
| **website_url** | **String** | The adviser's own website from Form ADV Schedule D Section 1.I (scheme and host lower-cased, path kept). Null for an agency and for an adviser whose only listed pages are social-media pages. | [optional] |
|
|
22
23
|
| **website_domain** | **String** | The host of website_url with the scheme, any port and a leading www stripped, lower-cased. It is never a social-media host. | [optional] |
|
|
@@ -46,6 +47,7 @@ instance = PharmaObservatory::InvestorsRow.new(
|
|
|
46
47
|
private_fund_count: null,
|
|
47
48
|
total_private_fund_gav: null,
|
|
48
49
|
portfolio_co_count: null,
|
|
50
|
+
portfolio_co_removed_count: null,
|
|
49
51
|
holdings_position_count: null,
|
|
50
52
|
website_url: null,
|
|
51
53
|
website_domain: null,
|
data/docs/LegalEntitiesApi.md
CHANGED
|
@@ -22,6 +22,7 @@ All URIs are relative to *https://pharmaobservatory.com*
|
|
|
22
22
|
| [**legal_entities_inspections**](LegalEntitiesApi.md#legal_entities_inspections) | **GET** /api/v1/legal_entities/{id}/inspections | FDA inspections |
|
|
23
23
|
| [**legal_entities_institutional_holdings**](LegalEntitiesApi.md#legal_entities_institutional_holdings) | **GET** /api/v1/legal_entities/{id}/institutional_holdings | Institutional holdings (SEC Form 13F) |
|
|
24
24
|
| [**legal_entities_institutional_quarter_totals**](LegalEntitiesApi.md#legal_entities_institutional_quarter_totals) | **GET** /api/v1/legal_entities/{id}/institutional_quarter_totals | Institutional quarter totals (SEC Form 13F) |
|
|
25
|
+
| [**legal_entities_investor_portfolio**](LegalEntitiesApi.md#legal_entities_investor_portfolio) | **GET** /api/v1/legal_entities/{id}/investor_portfolio | Investor portfolio (offering filings and investor websites) |
|
|
25
26
|
| [**legal_entities_legal_entity_sec_filings**](LegalEntitiesApi.md#legal_entities_legal_entity_sec_filings) | **GET** /api/v1/legal_entities/{id}/legal_entity_sec_filings | SEC filer records |
|
|
26
27
|
| [**legal_entities_list**](LegalEntitiesApi.md#legal_entities_list) | **GET** /api/v1/legal_entities | List legal entities |
|
|
27
28
|
| [**legal_entities_org_disclosure_trend**](LegalEntitiesApi.md#legal_entities_org_disclosure_trend) | **GET** /api/v1/legal_entities/{id}/org_disclosure_trend | Organization disclosure trend |
|
|
@@ -1460,6 +1461,85 @@ end
|
|
|
1460
1461
|
- **Accept**: application/json
|
|
1461
1462
|
|
|
1462
1463
|
|
|
1464
|
+
## legal_entities_investor_portfolio
|
|
1465
|
+
|
|
1466
|
+
> <InvestorPortfolioResponse> legal_entities_investor_portfolio(id, opts)
|
|
1467
|
+
|
|
1468
|
+
Investor portfolio (offering filings and investor websites)
|
|
1469
|
+
|
|
1470
|
+
### Examples
|
|
1471
|
+
|
|
1472
|
+
```ruby
|
|
1473
|
+
require 'time'
|
|
1474
|
+
require 'pharmaobservatory'
|
|
1475
|
+
# setup authorization
|
|
1476
|
+
PharmaObservatory.configure do |config|
|
|
1477
|
+
# Configure Bearer authorization (JWT): ApiBearerJwt
|
|
1478
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1479
|
+
end
|
|
1480
|
+
|
|
1481
|
+
api_instance = PharmaObservatory::LegalEntitiesApi.new
|
|
1482
|
+
id = 'edgar:0001114448' # String |
|
|
1483
|
+
opts = {
|
|
1484
|
+
cursor: 'cursor_example', # String | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
|
|
1485
|
+
limit: 56, # Integer | Rows per page, up to 500 (default 50).
|
|
1486
|
+
sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
|
|
1487
|
+
group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
|
|
1488
|
+
measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
|
|
1489
|
+
}
|
|
1490
|
+
|
|
1491
|
+
begin
|
|
1492
|
+
# Investor portfolio (offering filings and investor websites)
|
|
1493
|
+
result = api_instance.legal_entities_investor_portfolio(id, opts)
|
|
1494
|
+
p result
|
|
1495
|
+
rescue PharmaObservatory::ApiError => e
|
|
1496
|
+
puts "Error when calling LegalEntitiesApi->legal_entities_investor_portfolio: #{e}"
|
|
1497
|
+
end
|
|
1498
|
+
```
|
|
1499
|
+
|
|
1500
|
+
#### Using the legal_entities_investor_portfolio_with_http_info variant
|
|
1501
|
+
|
|
1502
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1503
|
+
|
|
1504
|
+
> <Array(<InvestorPortfolioResponse>, Integer, Hash)> legal_entities_investor_portfolio_with_http_info(id, opts)
|
|
1505
|
+
|
|
1506
|
+
```ruby
|
|
1507
|
+
begin
|
|
1508
|
+
# Investor portfolio (offering filings and investor websites)
|
|
1509
|
+
data, status_code, headers = api_instance.legal_entities_investor_portfolio_with_http_info(id, opts)
|
|
1510
|
+
p status_code # => 2xx
|
|
1511
|
+
p headers # => { ... }
|
|
1512
|
+
p data # => <InvestorPortfolioResponse>
|
|
1513
|
+
rescue PharmaObservatory::ApiError => e
|
|
1514
|
+
puts "Error when calling LegalEntitiesApi->legal_entities_investor_portfolio_with_http_info: #{e}"
|
|
1515
|
+
end
|
|
1516
|
+
```
|
|
1517
|
+
|
|
1518
|
+
### Parameters
|
|
1519
|
+
|
|
1520
|
+
| Name | Type | Description | Notes |
|
|
1521
|
+
| ---- | ---- | ----------- | ----- |
|
|
1522
|
+
| **id** | **String** | | |
|
|
1523
|
+
| **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
|
|
1524
|
+
| **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
|
|
1525
|
+
| **sort** | **String** | Comma separated columns, a leading minus for descending: sort=a,-b. | [optional] |
|
|
1526
|
+
| **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
|
|
1527
|
+
| **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
|
|
1528
|
+
|
|
1529
|
+
### Return type
|
|
1530
|
+
|
|
1531
|
+
[**InvestorPortfolioResponse**](InvestorPortfolioResponse.md)
|
|
1532
|
+
|
|
1533
|
+
### Authorization
|
|
1534
|
+
|
|
1535
|
+
[ApiBearerJwt](../README.md#ApiBearerJwt)
|
|
1536
|
+
|
|
1537
|
+
### HTTP request headers
|
|
1538
|
+
|
|
1539
|
+
- **Content-Type**: Not defined
|
|
1540
|
+
- **Accept**: application/json
|
|
1541
|
+
|
|
1542
|
+
|
|
1463
1543
|
## legal_entities_legal_entity_sec_filings
|
|
1464
1544
|
|
|
1465
1545
|
> <LegalEntitySecFilingsResponse> legal_entities_legal_entity_sec_filings(id, opts)
|
|
@@ -21,6 +21,8 @@
|
|
|
21
21
|
| **last_year** | **Integer** | Latest trial start year. | [optional] |
|
|
22
22
|
| **last_update_year** | **Integer** | Year the program's most recently updated trial record was posted. | [optional] |
|
|
23
23
|
| **withdrawn** | **Boolean** | True when the drug has been withdrawn. | [optional] |
|
|
24
|
+
| **owned** | **Boolean** | True when the sponsor is judged to develop the drug (an experimental arm, a regulatory holder, or an inferred lead); false when it is the backbone or comparator of a combination, one of many leads of a crowded drug, or not the holder of a generic. Every row is kept; this column labels it. | [optional] |
|
|
25
|
+
| **ownership_basis** | **String** | Why owned is what it is: experimental_arm, regulatory_holder or inferred_lead (owned), or backbone, comparator, crowded_not_lead or generic_not_holder (not owned). inferred_lead is an inference made where the trials give no arm evidence either way. | [optional] |
|
|
24
26
|
| **cause_name** | **String** | The Global Burden of Disease cause matched to the condition. | [optional] |
|
|
25
27
|
| **dalys_millions** | **Float** | Global disability-adjusted life years for the matched cause, in millions. | [optional] |
|
|
26
28
|
| **deaths_millions** | **Float** | Global deaths for the matched cause, in millions. | [optional] |
|
|
@@ -49,6 +51,8 @@ instance = PharmaObservatory::ProgramLicensingCandidatesRow.new(
|
|
|
49
51
|
last_year: null,
|
|
50
52
|
last_update_year: null,
|
|
51
53
|
withdrawn: null,
|
|
54
|
+
owned: null,
|
|
55
|
+
ownership_basis: null,
|
|
52
56
|
cause_name: null,
|
|
53
57
|
dalys_millions: null,
|
|
54
58
|
deaths_millions: null,
|