Skip to content

Commit c27eb3a

Browse files
committed
update-version-112.0.0
1 parent d7f8ed2 commit c27eb3a

159 files changed

Lines changed: 8741 additions & 2143 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.openapi-generator/FILES

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@ docs/PredictionSet.md
9797
docs/PredictionSetResults.md
9898
docs/PrimaryCell.md
9999
docs/PrimaryCellResults.md
100+
docs/PseudobulkSet.md
101+
docs/PseudobulkSetResults.md
100102
docs/Publication.md
101103
docs/PublicationResults.md
102104
docs/RNASeqKBInfo.md
@@ -245,6 +247,8 @@ igvf_client/models/prediction_set.py
245247
igvf_client/models/prediction_set_results.py
246248
igvf_client/models/primary_cell.py
247249
igvf_client/models/primary_cell_results.py
250+
igvf_client/models/pseudobulk_set.py
251+
igvf_client/models/pseudobulk_set_results.py
248252
igvf_client/models/publication.py
249253
igvf_client/models/publication_results.py
250254
igvf_client/models/reference_file.py

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ The Python client is autogenerated based on this [IGVF OpenAPI specification](ht
44

55
*Note while the API endpoints are relatively stable, the underlying data model is still evolving, and changing fields/types can cause breaking changes. The latest version of the client reflects the latest version of the schema used by the API.*
66

7-
- API version: 111.0.0
8-
- Package version: 111.0.0
7+
- API version: 112.0.0
8+
- Package version: 112.0.0
99
- Generator version: 7.7.0
1010
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
1111

@@ -149,6 +149,7 @@ Class | Method | HTTP request | Description
149149
*IgvfApi* | [**platform_terms**](docs/IgvfApi.md#platform_terms) | **GET** /platform-terms/@@listing | List items in the PlatformTerm collection.
150150
*IgvfApi* | [**prediction_sets**](docs/IgvfApi.md#prediction_sets) | **GET** /prediction-sets/@@listing | List items in the PredictionSet collection.
151151
*IgvfApi* | [**primary_cells**](docs/IgvfApi.md#primary_cells) | **GET** /primary-cells/@@listing | List items in the PrimaryCell collection.
152+
*IgvfApi* | [**pseudobulk_sets**](docs/IgvfApi.md#pseudobulk_sets) | **GET** /pseudobulk-sets/@@listing | List items in the PseudobulkSet collection.
152153
*IgvfApi* | [**publications**](docs/IgvfApi.md#publications) | **GET** /publications/@@listing | List items in the Publication collection.
153154
*IgvfApi* | [**reference_files**](docs/IgvfApi.md#reference_files) | **GET** /reference-files/@@listing | List items in the ReferenceFile collection.
154155
*IgvfApi* | [**rodent_donors**](docs/IgvfApi.md#rodent_donors) | **GET** /rodent-donors/@@listing | List items in the RodentDonor collection.
@@ -265,6 +266,8 @@ Class | Method | HTTP request | Description
265266
- [PredictionSetResults](docs/PredictionSetResults.md)
266267
- [PrimaryCell](docs/PrimaryCell.md)
267268
- [PrimaryCellResults](docs/PrimaryCellResults.md)
269+
- [PseudobulkSet](docs/PseudobulkSet.md)
270+
- [PseudobulkSetResults](docs/PseudobulkSetResults.md)
268271
- [Publication](docs/Publication.md)
269272
- [PublicationResults](docs/PublicationResults.md)
270273
- [RNASeqKBInfo](docs/RNASeqKBInfo.md)

docs/IgvfApi.md

Lines changed: 203 additions & 0 deletions
Large diffs are not rendered by default.

docs/Item.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Name | Type | Description | Notes
106106
**gene_list_for** | **List[str]** | File Set(s) that this file is a gene list for. | [optional]
107107
**loci_list_for** | **List[str]** | File Set(s) that this file is a loci list for. | [optional]
108108
**quality_metrics** | **List[str]** | The quality metrics that are associated with this file. | [optional]
109-
**assay_titles** | **List[str]** | Ontology term names from Ontology of Biomedical Investigations (OBI) for assays | [optional]
109+
**assay_titles** | **List[str]** | Ontology term names from Ontology of Biomedical Investigations (OBI) for assays. | [optional]
110110
**preferred_assay_titles** | **List[str]** | The custom lab preferred label for the experiment performed. | [optional]
111111
**href** | **str** | The download path to obtain file. | [optional]
112112
**s3_uri** | **str** | The S3 URI of public file object. | [optional]
@@ -149,10 +149,10 @@ Name | Type | Description | Notes
149149
**barcode_map_for** | **List[str]** | Link(s) to the Multiplexed samples using this file as barcode map. | [optional]
150150
**enrichment_design_for** | **List[str]** | Link(s) to the measurement sets using this file as a enrichment design. | [optional]
151151
**doi** | **str** | The Digital Object Identifier (DOI) associated with this object. | [optional]
152-
**input_file_sets** | **List[str]** | The file set(s) required for this prediction set. | [optional]
152+
**input_file_sets** | **List[str]** | The file set(s) required for this pseudobulking analysis. | [optional]
153153
**samples** | **List[str]** | The samples associated with this publication. | [optional]
154154
**donors** | **List[str]** | Donor(s) the sample was derived from. | [optional]
155-
**file_set_type** | **str** | The category that best describes this prediction set. | [optional]
155+
**file_set_type** | **str** | The level of this analysis set. | [optional]
156156
**external_image_data_url** | **str** | Links to the external site where images and related data produced by this analysis are stored. | [optional]
157157
**demultiplexed_samples** | **List[str]** | The sample(s) associated with this analysis set inferred through demultiplexing. | [optional]
158158
**uniform_pipeline_status** | **str** | The status of the single cell or Perturb-seq uniform pipeline processing for this analysis set, if applicable. | [optional]
@@ -210,6 +210,8 @@ Name | Type | Description | Notes
210210
**model_zoo_location** | **str** | The link to the model on the Kipoi repository. | [optional]
211211
**assessed_genes** | **List[str]** | A list of gene(s) assessed in this prediction set. This property is used to describe the gene(s) being investigated, especially how the input variables in the prediction set affect some critical functionality of the gene(s). For example, the effect could be predicted from genetic variants on the binding affinity of a transcription factor encoded by a gene (assessed_genes). It differs from small_scale_gene_list and large_scale_gene_list, as these are used when the input variables of the prediction set are genes. | [optional]
212212
**external_input_data** | **str** | A tabular file with links to external data utilized for this model. | [optional]
213+
**cell_type** | **str** | The ontology term that describes the cell type of the cells in this pseudobulk. | [optional]
214+
**cell_qualifier** | **str** | A qualifier that provides additional detail about the cell type annotation or the source biosample. | [optional]
213215
**geneid** | **str** | ENSEMBL GeneID of official nomenclature approved gene. The GeneID does not include the current version number suffix. | [optional]
214216
**symbol** | **str** | Gene symbol approved by the official nomenclature. | [optional]
215217
**study_sets** | **List[str]** | The studies of IGVF that this gene was a part of. | [optional]

docs/ItemType.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
MeasurementSet = 'MeasurementSet'
2828
ModelSet = 'ModelSet'
2929
PredictionSet = 'PredictionSet'
30+
PseudobulkSet = 'PseudobulkSet'
3031
Gene = 'Gene'
3132
Image = 'Image'
3233
InstitutionalCertificate = 'InstitutionalCertificate'

docs/PseudobulkSet.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# PseudobulkSet
2+
3+
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**doi** | **str** | The Digital Object Identifier (DOI) associated with this object. | [optional]
10+
**input_file_sets** | **List[str]** | The file set(s) required for this pseudobulking analysis. | [optional]
11+
**release_timestamp** | **str** | The date the object was released. | [optional]
12+
**publications** | **List[str]** | The publications associated with this object. | [optional]
13+
**documents** | **List[str]** | Documents that provide additional information (not data file). | [optional]
14+
**lab** | **str** | Lab associated with the submission. | [optional]
15+
**award** | **str** | Grant associated with the submission. | [optional]
16+
**accession** | **str** | A unique identifier to be used to reference the object prefixed with IGVF. | [optional]
17+
**alternate_accessions** | **List[str]** | Accessions previously assigned to objects that have been merged with this object. | [optional]
18+
**collections** | **List[str]** | Some samples are part of particular data collections. | [optional]
19+
**status** | **str** | The status of the metadata object. | [optional]
20+
**revoke_detail** | **str** | Explanation of why an object was transitioned to the revoked status. | [optional]
21+
**schema_version** | **str** | The version of the JSON schema that the server uses to validate the object. | [optional]
22+
**uuid** | **str** | The unique identifier associated with every object. | [optional]
23+
**notes** | **str** | DACC internal notes. | [optional]
24+
**aliases** | **List[str]** | Lab specific identifiers to reference an object. | [optional]
25+
**creation_timestamp** | **str** | The date the object was created. | [optional]
26+
**submitted_by** | **str** | The user who submitted the object. | [optional]
27+
**submitter_comment** | **str** | Additional information specified by the submitter to be displayed as a comment on the portal. | [optional]
28+
**description** | **str** | A plain text description of the object. | [optional]
29+
**dbxrefs** | **List[str]** | Identifiers from external resources that may have 1-to-1 or 1-to-many relationships with IGVF file sets. | [optional]
30+
**samples** | **List[str]** | The sample(s) from which the cells in this pseudobulk originated. | [optional]
31+
**donors** | **List[str]** | The donor(s) associated with this file set. | [optional]
32+
**file_set_type** | **str** | The level of this analysis set. | [optional]
33+
**supersedes** | **List[str]** | The file set(s) that this file set supersedes by virtue of being newer, better, or a fixed version of etc. than the one(s) it supersedes. | [optional]
34+
**cell_type** | **str** | The ontology term that describes the cell type of the cells in this pseudobulk. | [optional]
35+
**cell_qualifier** | **str** | A qualifier that provides additional detail about the cell type annotation or the source biosample. | [optional]
36+
**id** | **str** | | [optional]
37+
**type** | **List[str]** | | [optional]
38+
**summary** | **str** | | [optional]
39+
**files** | **List[str]** | The files associated with this file set. | [optional]
40+
**control_for** | **List[str]** | The file sets for which this file set is a control. | [optional]
41+
**superseded_by** | **List[str]** | File set(s) this file set is superseded by virtue of those file set(s) being newer, better, or a fixed version of etc. than this one. | [optional]
42+
**submitted_files_timestamp** | **str** | The timestamp the first file object in the file_set or associated auxiliary sets was created. | [optional]
43+
**input_for** | **List[str]** | The file sets that use this file set as an input. | [optional]
44+
**construct_library_sets** | **List[str]** | The construct library sets associated with the samples of this file set. | [optional]
45+
**data_use_limitation_summaries** | **List[str]** | The data use limitation summaries of institutional certificates covering the sample associated with this file set which are signed by the same lab (or their partner lab) as the lab that submitted this file set. | [optional]
46+
**controlled_access** | **bool** | The controlled access of the institutional certificates covering the sample associated with this file set which are signed by the same lab (or their partner lab) as the lab that submitted this file set. | [optional]
47+
**workflows** | **List[str]** | A workflow for computational analysis of genomic data. A workflow is made up of analysis steps. | [optional]
48+
**preferred_assay_titles** | **List[str]** | Preferred Assay Title(s) of assays that produced data analyzed in the pseudobulk set. | [optional]
49+
**assay_titles** | **List[str]** | Ontology term names from Ontology of Biomedical Investigations (OBI) for assays. | [optional]
50+
51+
## Example
52+
53+
```python
54+
from igvf_client.models.pseudobulk_set import PseudobulkSet
55+
56+
# TODO update the JSON string below
57+
json = "{}"
58+
# create an instance of PseudobulkSet from a JSON string
59+
pseudobulk_set_instance = PseudobulkSet.from_json(json)
60+
# print the JSON string representation of the object
61+
print(PseudobulkSet.to_json())
62+
63+
# convert the object into a dict
64+
pseudobulk_set_dict = pseudobulk_set_instance.to_dict()
65+
# create an instance of PseudobulkSet from a dict
66+
pseudobulk_set_from_dict = PseudobulkSet.from_dict(pseudobulk_set_dict)
67+
```
68+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
69+
70+

docs/PseudobulkSetResults.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# PseudobulkSetResults
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**graph** | [**List[PseudobulkSet]**](PseudobulkSet.md) | | [optional]
9+
**id** | **str** | | [optional]
10+
**type** | **List[str]** | | [optional]
11+
**total** | **int** | | [optional]
12+
**facets** | [**List[SearchFacet]**](SearchFacet.md) | | [optional]
13+
14+
## Example
15+
16+
```python
17+
from igvf_client.models.pseudobulk_set_results import PseudobulkSetResults
18+
19+
# TODO update the JSON string below
20+
json = "{}"
21+
# create an instance of PseudobulkSetResults from a JSON string
22+
pseudobulk_set_results_instance = PseudobulkSetResults.from_json(json)
23+
# print the JSON string representation of the object
24+
print(PseudobulkSetResults.to_json())
25+
26+
# convert the object into a dict
27+
pseudobulk_set_results_dict = pseudobulk_set_results_instance.to_dict()
28+
# create an instance of PseudobulkSetResults from a dict
29+
pseudobulk_set_results_from_dict = PseudobulkSetResults.from_dict(pseudobulk_set_results_dict)
30+
```
31+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
32+
33+

docs/SearchResultItem.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Name | Type | Description | Notes
106106
**gene_list_for** | **List[str]** | File Set(s) that this file is a gene list for. | [optional]
107107
**loci_list_for** | **List[str]** | File Set(s) that this file is a loci list for. | [optional]
108108
**quality_metrics** | **List[str]** | The quality metrics that are associated with this file. | [optional]
109-
**assay_titles** | **List[str]** | Ontology term names from Ontology of Biomedical Investigations (OBI) for assays | [optional]
109+
**assay_titles** | **List[str]** | Ontology term names from Ontology of Biomedical Investigations (OBI) for assays. | [optional]
110110
**preferred_assay_titles** | **List[str]** | The custom lab preferred label for the experiment performed. | [optional]
111111
**href** | **str** | The download path to obtain file. | [optional]
112112
**s3_uri** | **str** | The S3 URI of public file object. | [optional]
@@ -149,10 +149,10 @@ Name | Type | Description | Notes
149149
**barcode_map_for** | **List[str]** | Link(s) to the Multiplexed samples using this file as barcode map. | [optional]
150150
**enrichment_design_for** | **List[str]** | Link(s) to the measurement sets using this file as a enrichment design. | [optional]
151151
**doi** | **str** | The Digital Object Identifier (DOI) associated with this object. | [optional]
152-
**input_file_sets** | **List[str]** | The file set(s) required for this prediction set. | [optional]
152+
**input_file_sets** | **List[str]** | The file set(s) required for this pseudobulking analysis. | [optional]
153153
**samples** | **List[str]** | The samples associated with this publication. | [optional]
154154
**donors** | **List[str]** | Donor(s) the sample was derived from. | [optional]
155-
**file_set_type** | **str** | The category that best describes this prediction set. | [optional]
155+
**file_set_type** | **str** | The level of this analysis set. | [optional]
156156
**external_image_data_url** | **str** | Links to the external site where images and related data produced by this analysis are stored. | [optional]
157157
**demultiplexed_samples** | **List[str]** | The sample(s) associated with this analysis set inferred through demultiplexing. | [optional]
158158
**uniform_pipeline_status** | **str** | The status of the single cell or Perturb-seq uniform pipeline processing for this analysis set, if applicable. | [optional]
@@ -210,6 +210,8 @@ Name | Type | Description | Notes
210210
**model_zoo_location** | **str** | The link to the model on the Kipoi repository. | [optional]
211211
**assessed_genes** | **List[str]** | A list of gene(s) assessed in this prediction set. This property is used to describe the gene(s) being investigated, especially how the input variables in the prediction set affect some critical functionality of the gene(s). For example, the effect could be predicted from genetic variants on the binding affinity of a transcription factor encoded by a gene (assessed_genes). It differs from small_scale_gene_list and large_scale_gene_list, as these are used when the input variables of the prediction set are genes. | [optional]
212212
**external_input_data** | **str** | A tabular file with links to external data utilized for this model. | [optional]
213+
**cell_type** | **str** | The ontology term that describes the cell type of the cells in this pseudobulk. | [optional]
214+
**cell_qualifier** | **str** | A qualifier that provides additional detail about the cell type annotation or the source biosample. | [optional]
213215
**geneid** | **str** | ENSEMBL GeneID of official nomenclature approved gene. The GeneID does not include the current version number suffix. | [optional]
214216
**symbol** | **str** | Gene symbol approved by the official nomenclature. | [optional]
215217
**study_sets** | **List[str]** | The studies of IGVF that this gene was a part of. | [optional]

igvf_client/__init__.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
88
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
99
10-
The version of the OpenAPI document: 111.0.0
10+
The version of the OpenAPI document: 112.0.0
1111
Generated by OpenAPI Generator (https://openapi-generator.tech)
1212
1313
Do not edit the class manually.
1414
""" # noqa: E501
1515

1616

17-
__version__ = "111.0.0"
17+
__version__ = "112.0.0"
1818

1919
# import apis into sdk package
2020
from igvf_client.api.igvf_api import IgvfApi
@@ -125,6 +125,8 @@
125125
from igvf_client.models.prediction_set_results import PredictionSetResults
126126
from igvf_client.models.primary_cell import PrimaryCell
127127
from igvf_client.models.primary_cell_results import PrimaryCellResults
128+
from igvf_client.models.pseudobulk_set import PseudobulkSet
129+
from igvf_client.models.pseudobulk_set_results import PseudobulkSetResults
128130
from igvf_client.models.publication import Publication
129131
from igvf_client.models.publication_results import PublicationResults
130132
from igvf_client.models.rna_seq_kb_info import RNASeqKBInfo

0 commit comments

Comments
 (0)