pharmaobservatory 0.1.14 → 0.1.15
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 +8 -5
- data/docs/CompaniesApi.md +86 -4
- data/docs/CompanyAssetCollisionsResponse.md +58 -0
- data/docs/CompanyAssetCollisionsRow.md +68 -0
- data/docs/CompanyCompetitorsRow.md +16 -32
- data/lib/pharmaobservatory/api/companies_api.rb +93 -2
- data/lib/pharmaobservatory/models/company_asset_collisions_response.rb +478 -0
- data/lib/pharmaobservatory/models/company_asset_collisions_row.rb +502 -0
- data/lib/pharmaobservatory/models/company_competitors_row.rb +61 -153
- data/lib/pharmaobservatory/version.rb +1 -1
- data/lib/pharmaobservatory.rb +2 -0
- metadata +6 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a650a5fbd88e22cb8d5944c1e9c073f6e75e8f46131279503c697121a04a1177
|
|
4
|
+
data.tar.gz: d8dcdc1cc45826be2f252ed87abe4930db581a3eb54ced7818fa43adea3adc8f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 72a290819dfd7700dd187078be04f0644df2c5e84fc945c5e0a1e28eb521015ea085ea76b9c8fbaf1529d3e8c84367a8afcd4d9537c894dfede3a5f883880935
|
|
7
|
+
data.tar.gz: c76fc84201c4c5d1eeb8a910665d42eadcea0983d89d2e17f5c1f0069af3421417aaadd9a43771e8ccd1f8f01481f86df61d4b38cda72f9cd2d65be6d8e9f77e
|
data/README.md
CHANGED
|
@@ -39,7 +39,7 @@ Read-only REST API over the Pharma Observatory biomedical data platform. Referen
|
|
|
39
39
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
40
40
|
|
|
41
41
|
- API version: 1.0.0
|
|
42
|
-
- Package version: 0.1.
|
|
42
|
+
- Package version: 0.1.15
|
|
43
43
|
- Generator version: 7.13.0
|
|
44
44
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
45
45
|
|
|
@@ -56,16 +56,16 @@ gem build pharmaobservatory.gemspec
|
|
|
56
56
|
Then either install the gem locally:
|
|
57
57
|
|
|
58
58
|
```shell
|
|
59
|
-
gem install ./pharmaobservatory-0.1.
|
|
59
|
+
gem install ./pharmaobservatory-0.1.15.gem
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
(for development, run `gem install --dev ./pharmaobservatory-0.1.
|
|
62
|
+
(for development, run `gem install --dev ./pharmaobservatory-0.1.15.gem` to install the development dependencies)
|
|
63
63
|
|
|
64
64
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
65
65
|
|
|
66
66
|
Finally add this to the Gemfile:
|
|
67
67
|
|
|
68
|
-
gem 'pharmaobservatory', '~> 0.1.
|
|
68
|
+
gem 'pharmaobservatory', '~> 0.1.15'
|
|
69
69
|
|
|
70
70
|
### Install from Git
|
|
71
71
|
|
|
@@ -145,11 +145,12 @@ Class | Method | HTTP request | Description
|
|
|
145
145
|
*PharmaObservatory::CompaniesApi* | [**companies_biomarker_validation**](docs/CompaniesApi.md#companies_biomarker_validation) | **GET** /api/v1/companies/{id}/biomarker_validation | Biomarker validation ladder
|
|
146
146
|
*PharmaObservatory::CompaniesApi* | [**companies_catalysts**](docs/CompaniesApi.md#companies_catalysts) | **GET** /api/v1/companies/{id}/catalysts | Catalysts: trial readouts, patent cliffs, FDA decision dates and press-release events
|
|
147
147
|
*PharmaObservatory::CompaniesApi* | [**companies_clia_certificates**](docs/CompaniesApi.md#companies_clia_certificates) | **GET** /api/v1/companies/{id}/clia_certificates | CLIA laboratory certificates
|
|
148
|
+
*PharmaObservatory::CompaniesApi* | [**companies_company_asset_collisions**](docs/CompaniesApi.md#companies_company_asset_collisions) | **GET** /api/v1/companies/{id}/company_asset_collisions | Company asset collisions
|
|
148
149
|
*PharmaObservatory::CompaniesApi* | [**companies_company_assets**](docs/CompaniesApi.md#companies_company_assets) | **GET** /api/v1/companies/{id}/company_assets | Company assets (approved and marketed drugs)
|
|
149
150
|
*PharmaObservatory::CompaniesApi* | [**companies_company_biomarker_capability**](docs/CompaniesApi.md#companies_company_biomarker_capability) | **GET** /api/v1/companies/{id}/company_biomarker_capability | Company biomarker capability
|
|
150
151
|
*PharmaObservatory::CompaniesApi* | [**companies_company_collaborators**](docs/CompaniesApi.md#companies_company_collaborators) | **GET** /api/v1/companies/{id}/company_collaborators | Company study collaborators by disease area
|
|
151
152
|
*PharmaObservatory::CompaniesApi* | [**companies_company_competitor_activity**](docs/CompaniesApi.md#companies_company_competitor_activity) | **GET** /api/v1/companies/{id}/company_competitor_activity | Company competitor activity by disease area
|
|
152
|
-
*PharmaObservatory::CompaniesApi* | [**companies_company_competitors**](docs/CompaniesApi.md#companies_company_competitors) | **GET** /api/v1/companies/{id}/company_competitors | Company
|
|
153
|
+
*PharmaObservatory::CompaniesApi* | [**companies_company_competitors**](docs/CompaniesApi.md#companies_company_competitors) | **GET** /api/v1/companies/{id}/company_competitors | Company competitors by asset collision
|
|
153
154
|
*PharmaObservatory::CompaniesApi* | [**companies_company_cosponsors**](docs/CompaniesApi.md#companies_company_cosponsors) | **GET** /api/v1/companies/{id}/company_cosponsors | Company co-sponsors
|
|
154
155
|
*PharmaObservatory::CompaniesApi* | [**companies_company_financials**](docs/CompaniesApi.md#companies_company_financials) | **GET** /api/v1/companies/{id}/company_financials | Company SEC financials
|
|
155
156
|
*PharmaObservatory::CompaniesApi* | [**companies_company_firmographics**](docs/CompaniesApi.md#companies_company_firmographics) | **GET** /api/v1/companies/{id}/company_firmographics | Company firmographics
|
|
@@ -499,6 +500,8 @@ Class | Method | HTTP request | Description
|
|
|
499
500
|
- [PharmaObservatory::CompaniesRecordAttributes](docs/CompaniesRecordAttributes.md)
|
|
500
501
|
- [PharmaObservatory::CompaniesResponse](docs/CompaniesResponse.md)
|
|
501
502
|
- [PharmaObservatory::CompaniesRow](docs/CompaniesRow.md)
|
|
503
|
+
- [PharmaObservatory::CompanyAssetCollisionsResponse](docs/CompanyAssetCollisionsResponse.md)
|
|
504
|
+
- [PharmaObservatory::CompanyAssetCollisionsRow](docs/CompanyAssetCollisionsRow.md)
|
|
502
505
|
- [PharmaObservatory::CompanyAssetsResponse](docs/CompanyAssetsResponse.md)
|
|
503
506
|
- [PharmaObservatory::CompanyAssetsRow](docs/CompanyAssetsRow.md)
|
|
504
507
|
- [PharmaObservatory::CompanyBiomarkerCapabilityResponse](docs/CompanyBiomarkerCapabilityResponse.md)
|
data/docs/CompaniesApi.md
CHANGED
|
@@ -11,11 +11,12 @@ All URIs are relative to *https://pharmaobservatory.com*
|
|
|
11
11
|
| [**companies_biomarker_validation**](CompaniesApi.md#companies_biomarker_validation) | **GET** /api/v1/companies/{id}/biomarker_validation | Biomarker validation ladder |
|
|
12
12
|
| [**companies_catalysts**](CompaniesApi.md#companies_catalysts) | **GET** /api/v1/companies/{id}/catalysts | Catalysts: trial readouts, patent cliffs, FDA decision dates and press-release events |
|
|
13
13
|
| [**companies_clia_certificates**](CompaniesApi.md#companies_clia_certificates) | **GET** /api/v1/companies/{id}/clia_certificates | CLIA laboratory certificates |
|
|
14
|
+
| [**companies_company_asset_collisions**](CompaniesApi.md#companies_company_asset_collisions) | **GET** /api/v1/companies/{id}/company_asset_collisions | Company asset collisions |
|
|
14
15
|
| [**companies_company_assets**](CompaniesApi.md#companies_company_assets) | **GET** /api/v1/companies/{id}/company_assets | Company assets (approved and marketed drugs) |
|
|
15
16
|
| [**companies_company_biomarker_capability**](CompaniesApi.md#companies_company_biomarker_capability) | **GET** /api/v1/companies/{id}/company_biomarker_capability | Company biomarker capability |
|
|
16
17
|
| [**companies_company_collaborators**](CompaniesApi.md#companies_company_collaborators) | **GET** /api/v1/companies/{id}/company_collaborators | Company study collaborators by disease area |
|
|
17
18
|
| [**companies_company_competitor_activity**](CompaniesApi.md#companies_company_competitor_activity) | **GET** /api/v1/companies/{id}/company_competitor_activity | Company competitor activity by disease area |
|
|
18
|
-
| [**companies_company_competitors**](CompaniesApi.md#companies_company_competitors) | **GET** /api/v1/companies/{id}/company_competitors | Company
|
|
19
|
+
| [**companies_company_competitors**](CompaniesApi.md#companies_company_competitors) | **GET** /api/v1/companies/{id}/company_competitors | Company competitors by asset collision |
|
|
19
20
|
| [**companies_company_cosponsors**](CompaniesApi.md#companies_company_cosponsors) | **GET** /api/v1/companies/{id}/company_cosponsors | Company co-sponsors |
|
|
20
21
|
| [**companies_company_financials**](CompaniesApi.md#companies_company_financials) | **GET** /api/v1/companies/{id}/company_financials | Company SEC financials |
|
|
21
22
|
| [**companies_company_firmographics**](CompaniesApi.md#companies_company_firmographics) | **GET** /api/v1/companies/{id}/company_firmographics | Company firmographics |
|
|
@@ -641,6 +642,87 @@ end
|
|
|
641
642
|
- **Accept**: application/json
|
|
642
643
|
|
|
643
644
|
|
|
645
|
+
## companies_company_asset_collisions
|
|
646
|
+
|
|
647
|
+
> <CompanyAssetCollisionsResponse> companies_company_asset_collisions(id, opts)
|
|
648
|
+
|
|
649
|
+
Company asset collisions
|
|
650
|
+
|
|
651
|
+
### Examples
|
|
652
|
+
|
|
653
|
+
```ruby
|
|
654
|
+
require 'time'
|
|
655
|
+
require 'pharmaobservatory'
|
|
656
|
+
# setup authorization
|
|
657
|
+
PharmaObservatory.configure do |config|
|
|
658
|
+
# Configure Bearer authorization (JWT): ApiBearerJwt
|
|
659
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
660
|
+
end
|
|
661
|
+
|
|
662
|
+
api_instance = PharmaObservatory::CompaniesApi.new
|
|
663
|
+
id = 'company:c0185cf6c39a2536ad436cf6255494c0' # String |
|
|
664
|
+
opts = {
|
|
665
|
+
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.
|
|
666
|
+
limit: 56, # Integer | Rows per page, up to 500 (default 50).
|
|
667
|
+
sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
|
|
668
|
+
group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
|
|
669
|
+
measure: 'measure_example', # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
|
|
670
|
+
scope: 'company' # String | company (this company only) or group (its corporate group).
|
|
671
|
+
}
|
|
672
|
+
|
|
673
|
+
begin
|
|
674
|
+
# Company asset collisions
|
|
675
|
+
result = api_instance.companies_company_asset_collisions(id, opts)
|
|
676
|
+
p result
|
|
677
|
+
rescue PharmaObservatory::ApiError => e
|
|
678
|
+
puts "Error when calling CompaniesApi->companies_company_asset_collisions: #{e}"
|
|
679
|
+
end
|
|
680
|
+
```
|
|
681
|
+
|
|
682
|
+
#### Using the companies_company_asset_collisions_with_http_info variant
|
|
683
|
+
|
|
684
|
+
This returns an Array which contains the response data, status code and headers.
|
|
685
|
+
|
|
686
|
+
> <Array(<CompanyAssetCollisionsResponse>, Integer, Hash)> companies_company_asset_collisions_with_http_info(id, opts)
|
|
687
|
+
|
|
688
|
+
```ruby
|
|
689
|
+
begin
|
|
690
|
+
# Company asset collisions
|
|
691
|
+
data, status_code, headers = api_instance.companies_company_asset_collisions_with_http_info(id, opts)
|
|
692
|
+
p status_code # => 2xx
|
|
693
|
+
p headers # => { ... }
|
|
694
|
+
p data # => <CompanyAssetCollisionsResponse>
|
|
695
|
+
rescue PharmaObservatory::ApiError => e
|
|
696
|
+
puts "Error when calling CompaniesApi->companies_company_asset_collisions_with_http_info: #{e}"
|
|
697
|
+
end
|
|
698
|
+
```
|
|
699
|
+
|
|
700
|
+
### Parameters
|
|
701
|
+
|
|
702
|
+
| Name | Type | Description | Notes |
|
|
703
|
+
| ---- | ---- | ----------- | ----- |
|
|
704
|
+
| **id** | **String** | | |
|
|
705
|
+
| **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
|
|
706
|
+
| **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
|
|
707
|
+
| **sort** | **String** | Comma separated columns, a leading minus for descending: sort=a,-b. | [optional] |
|
|
708
|
+
| **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
|
|
709
|
+
| **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
|
|
710
|
+
| **scope** | **String** | company (this company only) or group (its corporate group). | [optional] |
|
|
711
|
+
|
|
712
|
+
### Return type
|
|
713
|
+
|
|
714
|
+
[**CompanyAssetCollisionsResponse**](CompanyAssetCollisionsResponse.md)
|
|
715
|
+
|
|
716
|
+
### Authorization
|
|
717
|
+
|
|
718
|
+
[ApiBearerJwt](../README.md#ApiBearerJwt)
|
|
719
|
+
|
|
720
|
+
### HTTP request headers
|
|
721
|
+
|
|
722
|
+
- **Content-Type**: Not defined
|
|
723
|
+
- **Accept**: application/json
|
|
724
|
+
|
|
725
|
+
|
|
644
726
|
## companies_company_assets
|
|
645
727
|
|
|
646
728
|
> <CompanyAssetsResponse> companies_company_assets(id, opts)
|
|
@@ -969,7 +1051,7 @@ end
|
|
|
969
1051
|
|
|
970
1052
|
> <CompanyCompetitorsResponse> companies_company_competitors(id, opts)
|
|
971
1053
|
|
|
972
|
-
Company
|
|
1054
|
+
Company competitors by asset collision
|
|
973
1055
|
|
|
974
1056
|
### Examples
|
|
975
1057
|
|
|
@@ -994,7 +1076,7 @@ opts = {
|
|
|
994
1076
|
}
|
|
995
1077
|
|
|
996
1078
|
begin
|
|
997
|
-
# Company
|
|
1079
|
+
# Company competitors by asset collision
|
|
998
1080
|
result = api_instance.companies_company_competitors(id, opts)
|
|
999
1081
|
p result
|
|
1000
1082
|
rescue PharmaObservatory::ApiError => e
|
|
@@ -1010,7 +1092,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
1010
1092
|
|
|
1011
1093
|
```ruby
|
|
1012
1094
|
begin
|
|
1013
|
-
# Company
|
|
1095
|
+
# Company competitors by asset collision
|
|
1014
1096
|
data, status_code, headers = api_instance.companies_company_competitors_with_http_info(id, opts)
|
|
1015
1097
|
p status_code # => 2xx
|
|
1016
1098
|
p headers # => { ... }
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# PharmaObservatory::CompanyAssetCollisionsResponse
|
|
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<CompanyAssetCollisionsRow>**](CompanyAssetCollisionsRow.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::CompanyAssetCollisionsResponse.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,68 @@
|
|
|
1
|
+
# PharmaObservatory::CompanyAssetCollisionsRow
|
|
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
|
+
| **molecule_id** | **String** | Molecule level: the company's asset, the resolved drug (a drug with two canonical ids is one asset). | [optional] |
|
|
12
|
+
| **molecule_name** | **String** | The asset's display name, from the company's most-trialled record of it. | [optional] |
|
|
13
|
+
| **competitor_company_id** | **String** | Company level: the company whose asset collides. | [optional] |
|
|
14
|
+
| **competitor_company_name** | **String** | Display name of the competitor's company. | [optional] |
|
|
15
|
+
| **competitor_group_id** | **String** | Group level: the competitor's current ultimate parent; a root's group is itself. | [optional] |
|
|
16
|
+
| **competitor_group_name** | **String** | Display name of the competitor's group. | [optional] |
|
|
17
|
+
| **competitor_molecule_id** | **String** | Molecule level: the competitor's asset, the resolved drug. | [optional] |
|
|
18
|
+
| **competitor_molecule_name** | **String** | The competitor asset's display name. | [optional] |
|
|
19
|
+
| **target_family** | **String** | The company drug's target family of the shared gene (the Open Targets target name, so a taxane's tubulin isotypes are one family; the ChEMBL mechanism text for a drug Open Targets lacks; the gene symbol for a curated investigational asset). | [optional] |
|
|
20
|
+
| **shared_symbols** | **Array<String>** | Gene symbols of the shared genes within the family. | [optional] |
|
|
21
|
+
| **action_type** | **String** | The company drug's action on the family (Open Targets or ChEMBL vocabulary); null when no source states one. | [optional] |
|
|
22
|
+
| **competitor_action_type** | **String** | The competitor drug's action on the shared genes; null when no source states one. | [optional] |
|
|
23
|
+
| **same_action** | **Boolean** | True when the two drugs have the same action type on a shared gene of the family. | [optional] |
|
|
24
|
+
| **n_shared_indications** | **Integer** | Disease areas both programs are in, among live programs. | [optional] |
|
|
25
|
+
| **top_shared_indications** | **Array<String>** | Up to 3 shared disease area names, by the pair's combined trial count. An empty list when none. | [optional] |
|
|
26
|
+
| **stage** | **Integer** | The less advanced of the two programs' furthest phase: 6 Phase 4, 5 Phase 3, 4 Phase 2/3, 3 Phase 2, 2 Phase 1/2, 1 Phase 1, 0 Early Phase 1, -1 phase not applicable. | [optional] |
|
|
27
|
+
| **last_year** | **Integer** | The later of the two programs' last trial start year. | [optional] |
|
|
28
|
+
| **n_head_to_head_trials** | **Integer** | Trials led by either company in which one drug is experimental and the other an active comparator. | [optional] |
|
|
29
|
+
| **ownership_basis** | **String** | Why the company owns the drug. experimental_arm and regulatory_holder rest on evidence; inferred_lead is an inference (no arm data says otherwise). | [optional] |
|
|
30
|
+
| **competitor_ownership_basis** | **String** | Why the competitor owns its drug, same vocabulary as ownership_basis. | [optional] |
|
|
31
|
+
| **family_idf** | **Float** | The rarity weight of the family: the natural log of (companies holding any live, owned target family) over (companies holding this one). | [optional] |
|
|
32
|
+
| **collision_weight** | **Float** | The weight of the pair, family_idf times a factor for same action, a shared indication, the stage, recency and a head-to-head trial. | [optional] |
|
|
33
|
+
|
|
34
|
+
## Example
|
|
35
|
+
|
|
36
|
+
```ruby
|
|
37
|
+
require 'pharmaobservatory'
|
|
38
|
+
|
|
39
|
+
instance = PharmaObservatory::CompanyAssetCollisionsRow.new(
|
|
40
|
+
company_id: null,
|
|
41
|
+
company_name: null,
|
|
42
|
+
group_id: null,
|
|
43
|
+
group_name: null,
|
|
44
|
+
molecule_id: null,
|
|
45
|
+
molecule_name: null,
|
|
46
|
+
competitor_company_id: null,
|
|
47
|
+
competitor_company_name: null,
|
|
48
|
+
competitor_group_id: null,
|
|
49
|
+
competitor_group_name: null,
|
|
50
|
+
competitor_molecule_id: null,
|
|
51
|
+
competitor_molecule_name: null,
|
|
52
|
+
target_family: null,
|
|
53
|
+
shared_symbols: null,
|
|
54
|
+
action_type: null,
|
|
55
|
+
competitor_action_type: null,
|
|
56
|
+
same_action: null,
|
|
57
|
+
n_shared_indications: null,
|
|
58
|
+
top_shared_indications: null,
|
|
59
|
+
stage: null,
|
|
60
|
+
last_year: null,
|
|
61
|
+
n_head_to_head_trials: null,
|
|
62
|
+
ownership_basis: null,
|
|
63
|
+
competitor_ownership_basis: null,
|
|
64
|
+
family_idf: null,
|
|
65
|
+
collision_weight: null
|
|
66
|
+
)
|
|
67
|
+
```
|
|
68
|
+
|
|
@@ -13,24 +13,16 @@
|
|
|
13
13
|
| **competitor_group_id** | **String** | Group level: the competitor's current ultimate parent; a root's group is itself. | [optional] |
|
|
14
14
|
| **competitor_group_name** | **String** | Display name of the competitor's group. | [optional] |
|
|
15
15
|
| **competitor_class** | **String** | The competitor's class: industry, or non_industry (not classed as industry by the sponsor-class rule: academic, hospital, government, nonprofit, and any record the rule does not reach). competitor_rank restarts at 1 within each class, so filter or sort on this column first. | [optional] |
|
|
16
|
-
| **n_class_candidates** | **Integer** | How many companies of this competitor_class
|
|
16
|
+
| **n_class_candidates** | **Integer** | How many companies of this competitor_class had at least one asset collision with the company before the top 25 were kept. The same value on every row of one company and class. | [optional] |
|
|
17
17
|
| **competitor_rank** | **Integer** | The competitor's rank within its competitor_class for the company by competitor_score (1 is the highest). | [optional] |
|
|
18
|
-
| **competitor_score** | **Float** |
|
|
19
|
-
| **
|
|
20
|
-
| **
|
|
21
|
-
| **
|
|
22
|
-
| **
|
|
23
|
-
| **
|
|
24
|
-
| **
|
|
25
|
-
| **
|
|
26
|
-
| **n_phase_overlap_targets** | **Integer** | Shared targets that both companies have taken to phase 2 or later. | [optional] |
|
|
27
|
-
| **n_company_targets** | **Integer** | Targets the company pursues (the Jaccard denominator). | [optional] |
|
|
28
|
-
| **n_competitor_targets** | **Integer** | Targets the competitor pursues. | [optional] |
|
|
29
|
-
| **n_company_indications** | **Integer** | Disease areas in the company's top 25. | [optional] |
|
|
30
|
-
| **n_competitor_indications** | **Integer** | Disease areas in the competitor's top 25. | [optional] |
|
|
31
|
-
| **top_shared_targets** | **Array<String>** | Up to 5 shared target gene symbols, by combined phase then combined trials. An empty list when none. | [optional] |
|
|
32
|
-
| **top_shared_indications** | **Array<String>** | Up to 5 shared disease area names, by combined trial count. An empty list when none. | [optional] |
|
|
33
|
-
| **top_shared_mechanisms** | **Array<String>** | Up to 3 shared mechanisms written as a gene symbol and an action, by combined phase then combined trials. An empty list when none. | [optional] |
|
|
18
|
+
| **competitor_score** | **Float** | The weighted share of the company's live target families that the competitor's live assets collide with, 0 to 100, rounded to four places. Each colliding family counts its best collision weight (rarity of the family across companies, times factors for same action, a shared indication, the least advanced stage, recency and a head-to-head trial), capped at the family's rarity weight; the sum is divided by the rarity weights of ALL the company's families. | [optional] |
|
|
19
|
+
| **n_collisions** | **Integer** | Asset pairs (a drug of the company, a drug of the competitor) that act on a common target. | [optional] |
|
|
20
|
+
| **n_colliding_families** | **Integer** | Target families of the company's live assets that the competitor collides with. | [optional] |
|
|
21
|
+
| **n_subject_families** | **Integer** | Target families of the company's own live, owned assets; the denominator of competitor_score is their rarity weights. | [optional] |
|
|
22
|
+
| **n_same_action** | **Integer** | Asset pairs whose drugs act on the shared target with the same action type. | [optional] |
|
|
23
|
+
| **n_shared_indication_pairs** | **Integer** | Asset pairs whose programs share at least one disease area. | [optional] |
|
|
24
|
+
| **n_head_to_head_trials** | **Integer** | Distinct trials led by either company in which one drug of a pair is experimental and the other an active comparator. | [optional] |
|
|
25
|
+
| **top_collisions** | **Array<String>** | Up to 3 strongest asset pairs as text: \"drug A / drug B: target family, stage, N shared indications\". The stage is the less advanced of the two programs. An ownership_basis of inferred_lead on the underlying pair (see company_asset_collisions) is an inference. | [optional] |
|
|
34
26
|
| **n_cosponsored_trials** | **Integer** | Distinct trials on which the company and the competitor are both named as sponsors, counted over their subtrees; 0 when none. A consortium trial (more than 25 sponsor companies) is left out. | [optional] |
|
|
35
27
|
|
|
36
28
|
## Example
|
|
@@ -51,21 +43,13 @@ instance = PharmaObservatory::CompanyCompetitorsRow.new(
|
|
|
51
43
|
n_class_candidates: null,
|
|
52
44
|
competitor_rank: null,
|
|
53
45
|
competitor_score: null,
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
n_phase_overlap_targets: null,
|
|
62
|
-
n_company_targets: null,
|
|
63
|
-
n_competitor_targets: null,
|
|
64
|
-
n_company_indications: null,
|
|
65
|
-
n_competitor_indications: null,
|
|
66
|
-
top_shared_targets: null,
|
|
67
|
-
top_shared_indications: null,
|
|
68
|
-
top_shared_mechanisms: null,
|
|
46
|
+
n_collisions: null,
|
|
47
|
+
n_colliding_families: null,
|
|
48
|
+
n_subject_families: null,
|
|
49
|
+
n_same_action: null,
|
|
50
|
+
n_shared_indication_pairs: null,
|
|
51
|
+
n_head_to_head_trials: null,
|
|
52
|
+
top_collisions: null,
|
|
69
53
|
n_cosponsored_trials: null
|
|
70
54
|
)
|
|
71
55
|
```
|
|
@@ -656,6 +656,97 @@ module PharmaObservatory
|
|
|
656
656
|
return data, status_code, headers
|
|
657
657
|
end
|
|
658
658
|
|
|
659
|
+
# Company asset collisions
|
|
660
|
+
# @param id [String]
|
|
661
|
+
# @param [Hash] opts the optional parameters
|
|
662
|
+
# @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
|
|
663
|
+
# @option opts [Integer] :limit Rows per page, up to 500 (default 50).
|
|
664
|
+
# @option opts [String] :sort Comma separated columns, a leading minus for descending: sort=a,-b.
|
|
665
|
+
# @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
|
|
666
|
+
# @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
|
|
667
|
+
# @option opts [String] :scope company (this company only) or group (its corporate group).
|
|
668
|
+
# @return [CompanyAssetCollisionsResponse]
|
|
669
|
+
def companies_company_asset_collisions(id, opts = {})
|
|
670
|
+
data, _status_code, _headers = companies_company_asset_collisions_with_http_info(id, opts)
|
|
671
|
+
data
|
|
672
|
+
end
|
|
673
|
+
|
|
674
|
+
# Company asset collisions
|
|
675
|
+
# @param id [String]
|
|
676
|
+
# @param [Hash] opts the optional parameters
|
|
677
|
+
# @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
|
|
678
|
+
# @option opts [Integer] :limit Rows per page, up to 500 (default 50).
|
|
679
|
+
# @option opts [String] :sort Comma separated columns, a leading minus for descending: sort=a,-b.
|
|
680
|
+
# @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
|
|
681
|
+
# @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
|
|
682
|
+
# @option opts [String] :scope company (this company only) or group (its corporate group).
|
|
683
|
+
# @return [Array<(CompanyAssetCollisionsResponse, Integer, Hash)>] CompanyAssetCollisionsResponse data, response status code and response headers
|
|
684
|
+
def companies_company_asset_collisions_with_http_info(id, opts = {})
|
|
685
|
+
if @api_client.config.debugging
|
|
686
|
+
@api_client.config.logger.debug 'Calling API: CompaniesApi.companies_company_asset_collisions ...'
|
|
687
|
+
end
|
|
688
|
+
# verify the required parameter 'id' is set
|
|
689
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
690
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompaniesApi.companies_company_asset_collisions"
|
|
691
|
+
end
|
|
692
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
|
|
693
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CompaniesApi.companies_company_asset_collisions, must be smaller than or equal to 500.'
|
|
694
|
+
end
|
|
695
|
+
|
|
696
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
|
697
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CompaniesApi.companies_company_asset_collisions, must be greater than or equal to 1.'
|
|
698
|
+
end
|
|
699
|
+
|
|
700
|
+
allowable_values = ["company", "group"]
|
|
701
|
+
if @api_client.config.client_side_validation && opts[:'scope'] && !allowable_values.include?(opts[:'scope'])
|
|
702
|
+
fail ArgumentError, "invalid value for \"scope\", must be one of #{allowable_values}"
|
|
703
|
+
end
|
|
704
|
+
# resource path
|
|
705
|
+
local_var_path = '/api/v1/companies/{id}/company_asset_collisions'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
706
|
+
|
|
707
|
+
# query parameters
|
|
708
|
+
query_params = opts[:query_params] || {}
|
|
709
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
|
710
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
711
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
712
|
+
query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?
|
|
713
|
+
query_params[:'measure'] = opts[:'measure'] if !opts[:'measure'].nil?
|
|
714
|
+
query_params[:'scope'] = opts[:'scope'] if !opts[:'scope'].nil?
|
|
715
|
+
|
|
716
|
+
# header parameters
|
|
717
|
+
header_params = opts[:header_params] || {}
|
|
718
|
+
# HTTP header 'Accept' (if needed)
|
|
719
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
720
|
+
|
|
721
|
+
# form parameters
|
|
722
|
+
form_params = opts[:form_params] || {}
|
|
723
|
+
|
|
724
|
+
# http body (model)
|
|
725
|
+
post_body = opts[:debug_body]
|
|
726
|
+
|
|
727
|
+
# return_type
|
|
728
|
+
return_type = opts[:debug_return_type] || 'CompanyAssetCollisionsResponse'
|
|
729
|
+
|
|
730
|
+
# auth_names
|
|
731
|
+
auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
|
|
732
|
+
|
|
733
|
+
new_options = opts.merge(
|
|
734
|
+
:operation => :"CompaniesApi.companies_company_asset_collisions",
|
|
735
|
+
:header_params => header_params,
|
|
736
|
+
:query_params => query_params,
|
|
737
|
+
:form_params => form_params,
|
|
738
|
+
:body => post_body,
|
|
739
|
+
:auth_names => auth_names,
|
|
740
|
+
:return_type => return_type
|
|
741
|
+
)
|
|
742
|
+
|
|
743
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
744
|
+
if @api_client.config.debugging
|
|
745
|
+
@api_client.config.logger.debug "API called: CompaniesApi#companies_company_asset_collisions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
746
|
+
end
|
|
747
|
+
return data, status_code, headers
|
|
748
|
+
end
|
|
749
|
+
|
|
659
750
|
# Company assets (approved and marketed drugs)
|
|
660
751
|
# @param id [String]
|
|
661
752
|
# @param [Hash] opts the optional parameters
|
|
@@ -1020,7 +1111,7 @@ module PharmaObservatory
|
|
|
1020
1111
|
return data, status_code, headers
|
|
1021
1112
|
end
|
|
1022
1113
|
|
|
1023
|
-
# Company
|
|
1114
|
+
# Company competitors by asset collision
|
|
1024
1115
|
# @param id [String]
|
|
1025
1116
|
# @param [Hash] opts the optional parameters
|
|
1026
1117
|
# @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
|
|
@@ -1035,7 +1126,7 @@ module PharmaObservatory
|
|
|
1035
1126
|
data
|
|
1036
1127
|
end
|
|
1037
1128
|
|
|
1038
|
-
# Company
|
|
1129
|
+
# Company competitors by asset collision
|
|
1039
1130
|
# @param id [String]
|
|
1040
1131
|
# @param [Hash] opts the optional parameters
|
|
1041
1132
|
# @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
|