API Reference¶
Basic package usage:
>>> import gemmapy
>>> api_instance = gemmapy.GemmaPy()
>>> api_response = api_instance.FUNCTION(args)
Where FUNCTION
is one of the methods of the gemmapy.GemmaPy
class described below.
Return types (classes) are described in gemmapy.sdk.models
(unless they are Pandas DataFrame
or AnnData objects).
gemmapy Package¶
Main package containing GemmaPy
class described below and gemmapy.sdk
subpackage containing lower level swagger generated code. Of the latter only gemmapy.sdk.models
module is documented here as its classes represent GemmaPy
method
return values.
gemmapy.GemmaPy Class¶
- class gemmapy.GemmaPy(auth=None, path='prod')[source]¶
Main API class
- Parameters:
auth (list) – (optional) A list or tuple of credential strings, e.g. (your_username, your_password)
devel (bool) – (optional) If True development version of Gemma API will be used. Default is False.
Methods
get_dataset_object
(datasets[, genes, ...])Return a data structure including all relevant data related to gene expression in a dataset.
get_dataset_annotations
(dataset, **kwargs)Retrieve the annotations of a dataset
Retrieves the differential expression resultSet(s) associated with the dataset.
Retrieve annotations and surface level stats for a dataset's differential analyses
get_dataset_expression
(dataset, **kwargs)Deprecated in favour of get_dataset_expression
get_dataset_platforms
(dataset, **kwargs)- type dataset:
str
|int
get_result_sets
([datasets, result_sets, ...])Returns queried result set
get_dataset_samples
(dataset, **kwargs)Retrieve the samples of a dataset
get_datasets_by_ids
(dataset[, filter, taxa, ...])- type dataset:
List
[Union
[str
,int
]]
get_gene_go_terms
(gene, **kwargs)- type gene:
str
|int
get_gene_locations
(gene, **kwargs)- type gene:
str
|int
get_gene_probes
(gene[, offset, limit])Retrieve the probes associated to a genes across all platforms
get_genes
(genes, **kwargs)Retrieve genes matching gene identifiers
get_platform_annotations
(platform, **kwargs)Gets Gemma's platform annotations including mappings of microarray probes to genes.
get_platform_datasets
(platform[, offset, limit])Retrieve all experiments using a given platform
get_platform_element_genes
(platform, probe)Retrieve the genes associated to a probe in a given platform
get_platforms_by_ids
(platforms[, filter, ...])Retrieve platforms by their identifiers
search_annotations
(query, **kwargs)Search for annotation tags
get_taxa
(**kwargs)Get all taxa within Gemma
- filter_properties(output_type='DataFrame')[source]¶
Some functions such as get_datasets and get_platforms include a filter argument that allows creation of more complex queries. This function returns a list of supported properties to be used in those filters
- Parameters:
output_type (str, optional) – Type to return. “DataFrame” or “dict”, defaults to ‘DataFrame’
- Returns:
DataFrame or dict containing supported properties and their data types
- Return type:
dict|DataFrame
- get_all_pages(fun, step_size=100, **kwargs)[source]¶
A convenience function to allow easy iteration over paginated outputs. If the function returns a DataFrame output will be merged by the rows, if the function returns a list (eg. ‘raw’ functions) a concatanated list will be returned
- Parameters:
fun (Callable) – A callable from gemmapy with offset and limit functions
step_size (int, optional) – Size of individual calls to the server. 100 is the maximum value and the default.
**kwargs –
arguments for the callable fun
- Returns:
A DataFrame or a list containing all the output depending on output of the callable
- Return type:
list|DataFrame
- get_child_terms(terms)[source]¶
When querying for ontology terms, Gemma propagates these terms to include any datasets with their child terms in the results. This function returns these children for any number of terms, including all children and the terms itself in the output vector
- Parameters:
terms (List[str]) – A list of ontology terms
- Returns:
An array containing descendends of the annotation terms,
including the terms themselves :rtype: List[str]
- get_dataset_annotations(dataset, **kwargs)[source]¶
Retrieve the annotations of a dataset
- Parameters:
dataset (str|int) – A numerical dataset identifier or a dataset short name
**kwargs –
Additional arguments to pass to raw.get_dataset_annotations
- Returns:
A DataFrame with information about the annotations of the queried dataset. The fields of the DataFrame are:
class_name: Name of the annotation class (e.g. organism part)
class_URI: URI for the annotation class
term_name: Name of the annotation term (e.g. lung)
term_URI: URI for the annotation term
object_class: Class of object that the term originated from.
- Return type:
DataFrame
- get_dataset_differential_expression_analyses(dataset, **kwargs)[source]¶
Retrieve annotations and surface level stats for a dataset’s differential analyses
- Parameters:
dataset (str|int) – A numerical dataset identifier or a dataset short name
**kwargs –
Additional arguments to pass to raw.get_dataset_differential_expression_analyses
- Returns:
A data table with information about the differential expression analysis of the queried dataset. Note that this funciton does not return differential expression values themselves. Use get_differential_expression_values to get differential expression values (see examples).
- The fields of the DataFrame are:
result_ID: Result set ID of the differential expression analysis. May represent multiple factors in a single model.
contrast_ID: Id of the specific contrast factor. Together with the result.ID they uniquely represent a given contrast.
experiment_ID: Id of the source experiment
factor_category: Category for the contrast
factor_category_URI: URI for the contrast category
factor_ID: ID of the factor
baseline_factors: Characteristics of the baseline. This field is a DataFrame
experimental_factors: Characteristics of the experimental group. This field is a DataFrame
isSubset: True if the result set belong to a subset, False if not. Subsets are created when performing differential expression to avoid unhelpful comparisons.
subset_factor: Characteristics of the subset. This field is a DataFrame
probes_analyzed: Number of probesets represented in the contrast
genes_analyzed: Number of genes represented in the contrast
- Return type:
DataFrame
- get_dataset_expression(dataset, **kwargs)[source]¶
Deprecated in favour of get_dataset_expression
- Return type:
DataFrame
- get_dataset_expression_for_genes(datasets, genes, keep_non_specific=False, consolidate=None, **kwargs)[source]¶
Retrieve the expression data matrix of a set of datasets and genes
- Parameters:
datasets (List[str|int]) – A numerical dataset identifier or a dataset short name
genes (List[int]) – An ensembl gene identifier which typically starts with ensg or an ncbi gene identifier or an official gene symbol approved by hgnc
keep_non_specific (bool, optional) – If True, results from probesets that are not specific to the gene will also be returned., defaults to False
consolidate (TYPE, optional) – An option for gene expression level consolidation. If empty, will return every probe for the genes. “pickmax” to pick the probe with the highest expression, “pickvar” to pick the prove with the highest variance and “average” for returning the average expression, defaults to None
**kwargs –
Additional arguments to pass to raw.get_dataset_expression_for_genes
- Returns:
A dict of DataFrames keyed to dataset ids
- Return type:
dict[int:DataFrame]
- get_dataset_object(datasets, genes=None, keep_non_specific=False, consolidate=None, result_sets=None, contrasts=None, meta_type='text', output_type='anndata', **kwargs)[source]¶
Return a data structure including all relevant data related to gene expression in a dataset. Either returns an anndata object or a dictionary with all the needed fields.
- Parameters:
datasets (List[str|int]) – Numerical dataset identifier dataset short names
genes (Optional[List[str|int]], optional) – An ncbi gene identifier an, ensembl gene identifier which typically starts with ensg or an official gene symbol approved by hgnc, defaults to None
keep_non_specific (TYPE, optional) – If True, results from probesets that are not specific to the gene will also be returned, defaults to False
consolidate (Optional[str], optional) – DESCRIPTION, An option for gene expression level consolidation. If empty, will return every probe for the genes. “pickmax” to pick the probe with the highest expression, “pickvar” to pick the prove with the highest variance and “average” for returning the average expression to None
result_sets (Optional[List[int]], optional) – Result set IDs of the a differential expression analysis. If provided, the output will only include the samples from the subset used in the result set ID. Must be the same length as datasets, defaults to None
contrasts (Optional[List[str]], optional) – Contrast IDs of a differential expression contrast. Need result_sets to be defined to work. If provided, the output will only include samples relevant to the ‘ specific contrats. Must be the same length as datasets.
meta_type (str, optional) – How should the metadata information should be included. Can be “text”, “uri” or “both”. “text” and “uri” options, defaults to None
meta_type – How should the metadata information should be included. Can be “text”, “uri” or “both”. “text” and “uri” options, defaults to ‘text’
output_type (str, optional) – Type of the returned object. “anndata” for an AnnData object and “dict” for a dictionary populated with DataFrames, defaults to ‘anndata’
**kwargs –
DESCRIPTION
- Raises:
ValueError – DESCRIPTION
- Returns:
A dictionary containing AnnData objects or nested dictionaries that contain expression and sample metada of the requested experiments
- Return type:
dict[int:dict|AnnData]
- get_dataset_platforms(dataset, **kwargs)[source]¶
- Parameters:
dataset (str|int) – A numerical dataset identifier or a dataset short name
**kwargs –
Additional arguments to pass to raw.get_dataset_platforms
- Returns:
A DataFrame with information about the platforms. The fields of the DataFrame are:
platform_ID: Id number of the platform given by Gemma
platform_type: Type of the platform.
platform_description: Free text field describing the platform.
platform_troubled: Whether the platform is marked as troubled by a Gemma curator.
taxon_name: Name of the species
taxon_scientific: Scientific name for the taxon
taxon_ID: Internal identifier given to the species by Gemma
taxon_NCBI: NCBI ID of the taxon
taxon_database_name: Underlying database used in Gemma for the taxon
taxon_database_ID: ID of the underlying database used in Gemma for the taxon
- Return type:
DataFrame
- get_dataset_processed_expression(dataset, **kwargs)[source]¶
Retrieve processed expression data of a dataset
- Parameters:
dataset (str|int) – numerical dataset identifier or a dataset short name
**kwargs –
Additional arguments to pass to raw.get_dataset_processed_expression
- Returns:
A DataFrame of the expression matrix for the queried dataset
- Return type:
DataFrame
- get_dataset_quantitation_types(dataset, **kwargs)[source]¶
Retrieve quantitation types of a dataset
- Parameters:
dataset (int|str) – A numerical dataset identifier or a dataset short name
**kwargs –
Additional arguments to pass to raw.get_dataset_quantitation_types
- Returns:
A DataFrame containing the quantitation types
- The fields of the output DataFrame are:
- id: If of the quantitation type. Any raw quantitation type can be
by get_dataset_raw_expression function using this id.
name: Name of the quantitation type
description: Description of the quantitation type
type: Type of the quantitation type. Either raw or processed. Each dataset will have one processed quantitation type which is the data returned using get_dataset_processed_expression
ratio: Whether or not the quanitation type is a ratio of multiple quantitation types. Typically TRUE for processed TWOCOLOR quantitation type.
preferred: The preferred raw quantitation type. This version is used in generation of the processed data within gemma.
recomputed: If TRUE this quantitation type is generated by recomputing raw data files Gemma had access to
- Return type:
DataFrame
- get_dataset_raw_expression(dataset, quantitation_type, **kwargs)[source]¶
- Parameters:
dataset (int|str) – A numerical dataset identifier or a dataset short name
quantitation_type ([int]) – Quantitation type id. These can be acquired using get_dataset_quantitation_types function. This endpoint can only return non-processed quantitation types.
**kwargs –
Additional arguments to pass to raw.get_dataset_raw_expression
- Returns:
A DataFrame of the expression matrix for the queried dataset
- Return type:
DataFrame
- get_dataset_samples(dataset, **kwargs)[source]¶
Retrieve the samples of a dataset
- Parameters:
dataset (int|str) – A numerical dataset identifier or a dataset short name
**kwargs –
Additional arguments to pass to raw.get_dataset_samples
- Returns:
A DataFrame with information about the samples of the queried dataset.
- The fields of the DataFrame are:
sample_name: Internal name given to the sample.
sample_ID: Internal ID of the sample
sample_description: Free text description of the sample
sample_outlier: Whether or not the sample is marked as an outlier
sample_accession: Accession ID of the sample in it’s original database
sample_database: Database of origin for the sample
sample_characteristics: Characteristics of the sample. This field is a data table
sample_factor_values: Experimental factor values of the sample. This field is a data table
- Return type:
DataFrame
- get_datasets(query=None, filter=None, taxa=None, uris=None, offset=0, limit=20, sort='+id', **kwargs)[source]¶
- Parameters:
query (Optional[str], optional) – The search query. Either plain text (‘traumatic’), or an ontology term URI (’http://purl.obolibrary.org/obo/UBERON_0002048’). Datasets that contain the given string in their short of full name will also be matched., defaults to None
filter (Optional[str], optional) – Filter results by matching expression. Use filter_properties function to get a list of all available parameters. These properties can be combined using “and” “or” clauses and may contain common operators such as “=”, “<” or “in”. (e.g. “taxon.commonName = human”, “taxon.commonName in (human,mouse), “id < 1000”), defaults to None
taxa (Optional[List[str]], optional) – A vector of taxon common names (e.g. human, mouse, rat). Providing multiple species will return results for all species. These are appended to the filter and equivalent to filtering for taxon.commonName property, defaults to None
taxa – A list of taxon common names (e.g. human, mouse, rat). Providing multiple species will return results for all species. These are appended to the filter and equivalent to filtering for taxon.commonName property, defaults to None
uris (Optional[List[str]], optional) – A vector of ontology term URIs. Providing multiple terms will return results containing any of the terms and their children. These are appended to the filter and equivalent to filtering for allCharacteristics.valueUri, defaults to None
offset (int, optional) – The offset of the first retrieved result., defaults to 0
limit (int, optional) – Limits the result to specified amount of objects. Has a maximum value of 100. Use together with offset and the total_elements attribute in the output to compile all data if needed. Alternatively get_all_pages function can be used with all functions including offset and limit parameters, defaults to 20
sort (str, optional) – Order results by the given property and direction. The ‘+’ sign indicate ascending order whereas the ‘-’ indicate descending, defaults to “+id”
**kwargs –
Additional arguments to pass to raw.get_datasets
- Returns:
A DataFrame with information about the queried dataset(s).
- The fields of the DataFrame are:
experiment_short_name: Shortname given to the dataset within Gemma. Often corresponds to accession ID
experiment_name: Full title of the dataset
experiment_ID: Internal ID of the dataset.
experiment_description: Description of the dataset
experiment_troubled: Did an automatic process within gemma or a curator mark the dataset as “troubled”
experiment_accession: Accession ID of the dataset in the external database it was taken from
experiment_database: The name of the database where the dataset was taken from
experiment_URI: URI of the original database
experiment_sample_count: Number of samples in the dataset
experiment_batch_effect_text: A text field describing whether the dataset has batch effects
experimen_batch_corrected: Whether batch correction has been performed on the dataset.
experimen_batch_confound: 0 if batch info isn’t available, -1 if batch counfoud is detected, 1 if batch information is available and no batch confound found
experimen_batch_effect: -1 if batch p value < 0.0001, 1 if batch p value > 0.1, 0 if otherwise and when there is no batch information is available or when the data is confounded with batches.
experimen_raw_data: -1 if no raw data available, 1 if raw data was available. When available, Gemma reprocesses raw data to get expression values and batches
geeq_q_score: Data quality score given to the dataset by Gemma.
geeq_s_score: Suitability score given to the dataset by Gemma. Refers to factors like batches, platforms and other aspects of experimental design
taxon_name: Name of the species
taxon_scientific: Scientific name for the taxon
taxon_ID: Internal identifier given to the species by Gemma
taxon_NCBI: NCBI ID of the taxon
taxon_database_name: Underlying database used in Gemma for the taxon
taxon_database_ID: ID of the underyling database used in Gemma for the taxon
- Return type:
DataFrame
- get_datasets_by_ids(dataset, filter=None, taxa=None, uris=None, offset=0, limit=20, sort='+id', **kwargs)[source]¶
- Parameters:
dataset (List[str|int]) – Numerical dataset identifiers or dataset short names.
filter (Optional[str], optional) – Filter results by matching expression. Use filter_properties function to get a list of all available parameters. These properties can be combined using “and” “or” clauses and may contain common operators such as “=”, “<” or “in”. (e.g. “taxon.commonName = human”, “taxon.commonName in (human,mouse), “id < 1000”), defaults to None
taxa (Optional[List[str]], optional) – A list of taxon common names (e.g. human, mouse, rat). Providing multiple species will return results for all species. These are appended to the filter and equivalent to filtering for taxon.commonName property, defaults to None
uris (Optional[List[str]], optional) – A vector of ontology term URIs. Providing multiple terms will return results containing any of the terms and their children. These are appended to the filter and equivalent to filtering for allCharacteristics.valueUri, defaults to None
offset (int, optional) – The offset of the first retrieved result., defaults to 0
limit (int, optional) – Limits the result to specified amount of objects. Has a maximum value of 100. Use together with offset and the total_elements attribute in the output to compile all data if needed. Alternatively get_all_pages function can be used with all functions including offset and limit parameters, defaults to 20
sort (str, optional) – Order results by the given property and direction. The ‘+’ sign indicate ascending order whereas the ‘-’ indicate descending, defaults to “+id”
**kwargs –
Additional arguments to pass to raw.get_datasets_by_ids
- Returns:
A DataFrame with information about the queried dataset(s).
- The fields of the DataFrame are:
experiment_short_name: Shortname given to the dataset within Gemma. Often corresponds to accession ID
experiment_name: Full title of the dataset
experiment_ID: Internal ID of the dataset.
experiment_description: Description of the dataset
experiment_troubled: Did an automatic process within gemma or a curator mark the dataset as “troubled”
experiment_accession: Accession ID of the dataset in the external database it was taken from
experiment_database: The name of the database where the dataset was taken from
experiment_URI: URI of the original database
experiment_sample_count: Number of samples in the dataset
experiment_batch_effect_text: A text field describing whether the dataset has batch effects
experimen_batch_corrected: Whether batch correction has been performed on the dataset.
experimen_batch_confound: 0 if batch info isn’t available, -1 if batch counfoud is detected, 1 if batch information is available and no batch confound found
experimen_batch_effect: -1 if batch p value < 0.0001, 1 if batch p value > 0.1, 0 if otherwise and when there is no batch information is available or when the data is confounded with batches.
experimen_raw_data: -1 if no raw data available, 1 if raw data was available. When available, Gemma reprocesses raw data to get expression values and batches
geeq_q_score: Data quality score given to the dataset by Gemma.
geeq_s_score: Suitability score given to the dataset by Gemma. Refers to factors like batches, platforms and other aspects of experimental design
taxon_name: Name of the species
taxon_scientific: Scientific name for the taxon
taxon_ID: Internal identifier given to the species by Gemma
taxon_NCBI: NCBI ID of the taxon
taxon_database_name: Underlying database used in Gemma for the taxon
taxon_database_ID: ID of the underyling database used in Gemma for the taxon
- Return type:
DataFrame
- get_differential_expression_values(dataset=None, result_sets=None, readable_contrasts=False, **kwargs)[source]¶
Retrieves the differential expression resultSet(s) associated with the dataset. If there is more than one resultSet, use get_result_sets() to see the options and get the ID you want. Alternatively, you can query the resultSet directly if you know its ID beforehand.
In Gemma each result set corresponds to the estimated effects associated with a single factor in the design, and each can have multiple contrasts (for each level compared to baseline). Thus a dataset with a 2x3 factorial design will have two result sets, one of which will have one contrast, and one having two contrasts.
The methodology for differential expression is explained in Curation of over 10000 transcriptomic studies to enable data reuse. Briefly, differential expression analysis is performed on the dataset based on the annotated experimental design with up two three potentially nested factors. Gemma attempts to automatically assign baseline conditions for each factor. In the absence of a clear control condition, a baseline is arbitrarily selected. A generalized linear model with empirical Bayes shrinkage of t-statistics is fit to the data for each platform element (probe/gene) using an implementation of the limma algorithm. For RNA-seq data, we use weighted regression, applying the voom algorithm to compute weights from the mean–variance relationship of the data. Contrasts of each condition are then computed compared to the selected baseline. In some situations, Gemma will split the data into subsets for analysis. A typical such situation is when a ‘batch’ factor is present and confounded with another factor, the subsets being determined by the levels of the confounding factor.
- Parameters:
dataset (Optional[str|int], optional) – A dataset identifier, defaults to None
result_sets (Optional[List[str|int]], optional) – result set identifiers. If a dataset is not provided, all result sets will be downloaded. If it is provided it will only be used to ensure all result sets belong to the dataset, defaults to None
readable_contrasts (bool, optional) – If False (default), the returned columns will use internal constrasts IDs as names. Details about the contrasts can be accessed using get_dataset_differential_expression_analyses(). If True IDs will be replaced with human readable contrast information, defaults to False
**kwargs –
- Raises:
ValueError – Will return a value error if neither result_sets nor a dataset is provided
- Returns:
A list of data frames with differential expression values per result set.
- Return type:
List[DataFrame]
- get_gene_go_terms(gene, **kwargs)[source]¶
- Parameters:
gene (str|int) – An ensembl gene identifier which typically starts with ensg or an ncbi gene identifier or an official gene symbol approved by hgnc
**kwargs –
Additional arguments to pass to raw.get_gene_go_terms
- Returns:
A DataFrame with information about the GO terms assigned to the queried gene The fields of the output DataFrame are:
term_name: Name of the term
term_ID: ID of the term
term_URI: URI of the term
- Return type:
DataFrame
- get_gene_locations(gene, **kwargs)[source]¶
- Parameters:
gene (str|int) – DESCRIPTION
**kwargs –
DAdditional arguments to pass to raw.get_gene_locations
- Returns:
A DataFrame with information about the physical location of the queried gene The fields of the output DataFrame are:
chromosome: Name of the chromosome the gene is located
strand: Which strand the gene is located
nucleotide: Nucleotide number for the gene
length: Gene length
taxon_name: Name of the species
taxon_scientific: Scientific name for the taxon
taxon_ID: Internal identifier given to the species by Gemma
taxon_NCBI: NCBI ID of the taxon
taxon_database_name: Underlying database used in Gemma for the taxon
taxon_database_ID: ID of the underlying database used in Gemma for the taxon
- Return type:
DataFrame
- get_gene_probes(gene, offset=0, limit=20, **kwargs)[source]¶
Retrieve the probes associated to a genes across all platforms
- Parameters:
gene (str|int) – An ensembl gene identifier which typically starts with ensg or an ncbi gene identifier or an official gene symbol approved by hgnc
offset (int, optional) – The offset of the first retrieved result., defaults to 0
limit (int, optional) – Limits the result to specified amount of objects. Has a maximum value of 100. Use together with offset and the total_elements attribute in the output to compile all data if needed. Alternatively get_all_pages function can be used with all functions including offset and limit parameters, defaults to 20
**kwargs –
Additional arguments to pass to raw.get_gene_probes
- Returns:
A DataFrame with information about the probes representing a gene across all platrofms.
- The fields of the output DataFrame are:
element_name: Name of the element. Typically the probeset name
element_description: A free text field providing optional information about the element
platform_short_name: Shortname of the platform given by Gemma. Typically the GPL identifier.
platform_name: Full name of the platform
platform_ID: Id number of the platform given by Gemma
platform_type: Type of the platform.
platform_description: Free text field describing the platform.
platform_troubled: Whether the platform is marked as troubled by a Gemma curator.
taxon_name: Name of the species
taxon_scientific: Scientific name for the taxon
taxon_ID: Internal identifier given to the species by Gemma
taxon_NCBI: NCBI ID of the taxon
taxon_database_name: Underlying database used in Gemma for the taxon
taxon_database_ID: ID of the underlying database used in Gemma for the taxon
- Return type:
DataFrame
- get_genes(genes, **kwargs)[source]¶
Retrieve genes matching gene identifiers
- Parameters:
genes (int|str) – An ensembl gene identifier which typically starts with ensg or an ncbi gene identifier or an official gene symbol approved by hgnc
**kwargs –
Additional arguments to pass to raw_get_genes
- Returns:
A DataFrame with the information about the querried genes.
- The fields of the output DataFrame are:
gene_symbol: Symbol for the gene
gene_ensembl: Ensembl ID for the gene
gene_NCBI: NCBI id for the gene
gene_name: Name of the gene
gene_aliases: Gene aliases. Each row includes a vector
gene_MFX_rank: Multifunctionality rank for the gene
taxon_name: Name of the species
taxon_scientific: Scientific name for the taxon
taxon_ID: Internal identifier given to the species by Gemma
taxon_NCBI: NCBI ID of the taxon
taxon_database_name: Underlying database used in Gemma for the taxon
taxon_database_ID: ID of the underlying database used in Gemma for the taxon
- Return type:
DataFrame
- get_platform_annotations(platform, **kwargs)[source]¶
Gets Gemma’s platform annotations including mappings of microarray probes to genes.
- Parameters:
platform (int|str) – A platform numerical identifier or a platform short name
**kwargs –
Additional arguments to pass to raw.get_platform_annotations
- Returns:
A DataFrame of annotations
ProbeName: Probeset names provided by the platform. Gene symbols for generic annotations
GeneSymbols: Genes that were found to be aligned to the probe sequence. Note that it is possible for probes to be non-specific. Alignment to multiple genes are indicated with gene symbols separated by “|”s
GeneNames: Name of the gene
GOTerms: GO Terms associated with the genes. annotType argument can be used to choose which terms should be included.
GemmaIDs and NCBIids: respective IDs for the genes.
- Return type:
DataFrame
- get_platform_datasets(platform, offset=0, limit=20, **kwargs)[source]¶
Retrieve all experiments using a given platform
- Parameters:
platform (str|int) – A platform numerical identifier or a platform short name
offset (int, optional) – The offset of the first retrieved result., defaults to 0
limit (int, optional) – Limits the result to specified amount of objects. Has a maximum value of 100. Use together with offset and the total_elements attribute in the output to compile all data if needed. Alternatively get_all_pages function can be used with all functions including offset and limit parameters, defaults to 20
**kwargs –
Additional arguments to pass to raw.get_platform_datasets
- Returns:
A DataFrame with information about the queried dataset(s).
- The fields of the DataFrame are:
experiment_short_name: Shortname given to the dataset within Gemma. Often corresponds to accession ID
experiment_name: Full title of the dataset
experiment_ID: Internal ID of the dataset.
experiment_description: Description of the dataset
experiment_troubled: Did an automatic process within gemma or a curator mark the dataset as “troubled”
experiment_accession: Accession ID of the dataset in the external database it was taken from
experiment_database: The name of the database where the dataset was taken from
experiment_URI: URI of the original database
experiment_sample_count: Number of samples in the dataset
experiment_batch_effect_text: A text field describing whether the dataset has batch effects
experimen_batch_corrected: Whether batch correction has been performed on the dataset.
experimen_batch_confound: 0 if batch info isn’t available, -1 if batch counfoud is detected, 1 if batch information is available and no batch confound found
experimen_batch_effect: -1 if batch p value < 0.0001, 1 if batch p value > 0.1, 0 if otherwise and when there is no batch information is available or when the data is confounded with batches.
experimen_raw_data: -1 if no raw data available, 1 if raw data was available. When available, Gemma reprocesses raw data to get expression values and batches
geeq_q_score: Suitability score given to the dataset by Gemma. Refers to factors like batches, platforms and other aspects of experimental design
geeq_s_score: Data quality score given to the dataset by Gemma.
taxon_name: Name of the species
taxon_scientific: Scientific name for the taxon
taxon_ID: Internal identifier given to the species by Gemma
taxon_NCBI: NCBI ID of the taxon
taxon_database_name: Underlying database used in Gemma for the taxon
taxon_database_ID: ID of the underyling database used in Gemma for the taxon
- Return type:
DataFrame
- get_platform_element_genes(platform, probe, offset=0, limit=20, **kwargs)[source]¶
Retrieve the genes associated to a probe in a given platform
- Parameters:
platform (str|int) – A platform numerical identifier or a platform short name
probe (str|int) – A probe name or it’s numerical identifier
offset (int, optional) – The offset of the first retrieved result., defaults to 0
limit (int, optional) – Limits the result to specified amount of objects. Has a maximum value of 100. Use together with offset and the total_elements attribute in the output to compile all data if needed. Alternatively get_all_pages function can be used with all functions including offset and limit parameters, defaults to 20
**kwargs –
Additional arguments to pass to raw.get_platform_element_genes
- Returns:
A DataFrame with the information about querried gene(s). The fields of the output DataFrame are:
gene_symbol: Symbol for the gene
gene_ensembl: Ensembl ID for the gene
gene_NCBI: NCBI id for the gene
gene_name: Name of the gene
gene_aliases: Gene aliases. Each row includes a vector
gene_MFX_rank: Multifunctionality rank for the gene
taxon_name: Name of the species
taxon_scientific: Scientific name for the taxon
taxon_ID: Internal identifier given to the species by Gemma
taxon_NCBI: NCBI ID of the taxon
taxon_database_name: Underlying database used in Gemma for the taxon
taxon_database_ID: ID of the underlying database used in Gemma for the taxon
- Return type:
DataFrame
- get_platforms(filter=None, taxa=None, offset=0, limit=20, sort='+id', **kwargs)[source]¶
Retrieve all platforms
- Parameters:
filter (str, optional) – Filter results by matching expression. Use filter_properties function to get a list of all available parameters. These properties can be combined using “and” “or” clauses and may contain common operators such as “=”, “<” or “in”. (e.g. “taxon.commonName = human”, “taxon.commonName in (human,mouse), “id < 1000”), defaults to None
taxa (List[str], optional) – A list of taxon common names (e.g. human, mouse, rat). Providing multiple species will return results for all species. These are appended to the filter and equivalent to filtering for taxon.commonName property, defaults to None
offset (int, optional) – The offset of the first retrieved result., defaults to 0
limit (int, optional) – Limits the result to specified amount of objects. Has a maximum value of 100. Use together with offset and the total_elements attribute in the output to compile all data if needed. Alternatively get_all_pages function can be used with all functions including offset and limit parameters, defaults to 20
sort (str, optional) – Order results by the given property and direction. The ‘+’ sign indicate ascending order whereas the ‘-’ indicate descending, defaults to “+id”
**kwargs –
Additional arguments to raw.get_platforms_by_ids
- Returns:
A DataFrame with information about the platform(s).
The fields of the output DataFrame are:
platform_ID: Internal identifier of the platform
platform_short_name: Shortname of the platform.
platform_name: Full name of the platform.
platform_description: Free text description of the platform
platform_troubled: Whether or not the platform was marked “troubled” by a Gemma process or a curator
platform_experiment_count: Number of experiments using the platform within Gemma
platform_type: Technology type for the platform.
taxon_name: Name of the species platform was made for
taxon_scientific: Scientific name for the taxon
taxon_ID: Internal identifier given to the species by Gemma
taxon_NCBI: NCBI ID of the taxon
taxon_database_name: Underlying database used in Gemma for the taxon
taxon_database_ID: ID of the underyling database used in Gemma for the taxon
- Return type:
DataFrame
- get_platforms_by_ids(platforms, filter=None, taxa=None, offset=0, limit=20, sort='+id', **kwargs)[source]¶
Retrieve platforms by their identifiers
- Parameters:
platforms (List[str|int]) – Platform numerical identifiers or platform short names.
filter (str, optional) – Filter results by matching expression. Use filter_properties function to get a list of all available parameters. These properties can be combined using “and” “or” clauses and may contain common operators such as “=”, “<” or “in”. (e.g. “taxon.commonName = human”, “taxon.commonName in (human,mouse), “id < 1000”), defaults to None
taxa (List[str], optional) – A list of taxon common names (e.g. human, mouse, rat). Providing multiple species will return results for all species. These are appended to the filter and equivalent to filtering for taxon.commonName property, defaults to None
offset (int, optional) – The offset of the first retrieved result., defaults to 0
limit (int, optional) – Limits the result to specified amount of objects. Has a maximum value of 100. Use together with offset and the total_elements attribute in the output to compile all data if needed. Alternatively get_all_pages function can be used with all functions including offset and limit parameters, defaults to 20
sort (str, optional) – Order results by the given property and direction. The ‘+’ sign indicate ascending order whereas the ‘-’ indicate descending, defaults to “+id”
**kwargs –
Additional arguments to raw.get_platforms_by_ids
- Returns:
A DataFrame with information about the platform(s).
The fields of the output DataFrame are:
platform_ID: Internal identifier of the platform
platform_short_name: Shortname of the platform.
platform_name: Full name of the platform.
platform_description: Free text description of the platform
platform_troubled: Whether or not the platform was marked “troubled” by a Gemma process or a curator
platform_experiment_count: Number of experiments using the platform within Gemma
platform_type: Technology type for the platform.
taxon_name: Name of the species platform was made for
taxon_scientific: Scientific name for the taxon
taxon_ID: Internal identifier given to the species by Gemma
taxon_NCBI: NCBI ID of the taxon
taxon_database_name: Underlying database used in Gemma for the taxon
taxon_database_ID: ID of the underyling database used in Gemma for the taxon
- Return type:
DataFrame
- get_result_sets(datasets=None, result_sets=None, filter=None, offset=0, limit=20, sort='+id', **kwargs)[source]¶
Returns queried result set
Output and usage of this function is mostly identical to get_dataset_differential_expression_analyses. The principal difference being the ability to restrict your result sets, being able to query across multiple datasets and being able to use the filter argument to search based on result set properties.
- Parameters:
datasets (Optional[List[str|int]], optional) – A numerical dataset identifier or a dataset short name, defaults to None
result_sets (Optional[List[int]], optional) – A result set identifier. Note that result set identifiers are not static and can change when Gemma re-runs analyses internally. Whem using these as inputs, try to make sure you access a currently existing result set ID by basing them on result sets returned for a particular dataset or filter used in get_result_sets, defaults to None
filter (str, optional) – Filter results by matching expression. Use filter_properties function to get a list of all available parameters. These properties can be combined using “and” “or” clauses and may contain common operators such as “=”, “<” or “in”. (e.g. “taxon.commonName = human”, “taxon.commonName in (human,mouse), “id < 1000”), defaults to None
offset (int, optional) – The offset of the first retrieved result., defaults to 0
limit (int, optional) – Limits the result to specified amount of objects. Has a maximum value of 100. Use together with offset and the total_elements attribute in the output to compile all data if needed. Alternatively get_all_pages function can be used with all functions including offset and limit parameters, defaults to 20
sort (str, optional) – Order results by the given property and direction. The ‘+’ sign indicate ascending order whereas the ‘-’ indicate descending, defaults to “+id”
**kwargs –
Additional arguments to pass to raw.get_result_sets
- Returns:
A DataFrame with information about the queried result sets. Note that this function does not return differential expression values themselves
- The fields of the DataFrame are:
result_ID: Result set ID of the differential expression analysis. May represent multiple factors in a single model.
contrast_ID: Id of the specific contrast factor. Together with the result.ID they uniquely represent a given contrast.
experiment_ID: Id of the source experiment
factor_category: Category for the contrast
factor_category_URI: URI for the baseline category
factor_ID: ID of the factor
baseline_factors: Characteristics of the baseline. This field is a DataFrame
experimental_factors: Characteristics of the experimental group. This field is a DataFrame
is_subset: True if the result set belong to a subset, False if not. Subsets are created when performing differential expression to avoid unhelpful comparisons.
subset_factor: Characteristics of the subset. This field is a DataFrame
- Return type:
DataFrame
- get_taxa(**kwargs)[source]¶
Get all taxa within Gemma
- Parameters:
**kwargs –
Additional arguments to raw.get_taxa
- Returns:
A DataFrame including the names, IDs and database information about the taxons
- Return type:
DataFrame
- make_design(samples, meta_type='text')[source]¶
Using on the output of get_dataset_samples, this function creates a simplified design table, granting one column to each experimental variable
- Parameters:
samples (DataFrame) – An output from get_dataset_samples.
meta_type (str, optional) – Type of metadata to include in the output. “text”, “uri” or “both”, defaults to ‘text’
- Returns:
A DataFrame including the design table for the dataset
- Return type:
DataFrame
- search_annotations(query, **kwargs)[source]¶
Search for annotation tags
- Parameters:
query (List[str]) – The search query
**kwargs –
Additional arguments to pass to raw.search_annotations
- Returns:
A DataFrame with annotations matching the given identifiers. The fields of the DataFrame are:
category_name: Category that the annotation belongs to
category_URI: URI for the category_name
value_name: Annotation term
value_URI: URI for the value_name
- Return type:
DataFrame
- search_gemma(query, taxon=None, platform=None, limit=100, result_type='experiment', **kwargs)[source]¶
Search everything in Gemma
- Parameters:
query (str) – The search query. Either plain text (‘traumatic’), or an ontology term URI (’http://purl.obolibrary.org/obo/UBERON_0002048’). Datasets that contain the given string in their short of full name will also be matched. Can be multiple identifiers separated by commas.
taxon (Optional[str|int], optional) – A numerical taxon identifier or an ncbi taxon identifier or a taxon identifier that matches either its scientific or common name, defaults to None
platform (Optional[str|int], optional) – A platform numerical identifier or a platform short name, defaults to None
limit (int, optional) – Defaults to 100 with a maximum value of 2000. Limits the number of returned results. Note that this function does not support pagination., defaults to 100
result_type (str, optional) – The kind of results that should be included in the output. Can be “experiment”, “gene”, “platform” or a long object type name, documented in the API documentation., defaults to “experiment”
**kwargs –
Additional arguments to raw.search
- Returns:
A list containing the results. Actual results are under the result_object component as dicts
- Return type:
list[sdk.SearchResultValueObjectObject]
gemmapy.sdk.models Subpackage¶
The subpackage contains most of classes which instances
are returned by GemmaPy
methods.
Gemma RESTful API
This website documents the usage of the [Gemma RESTful API](https://gemma.msl.ubc.ca/rest/v2/). Here you can find example script usage of the API, as well as graphical interface for each endpoint, with description of its parameters and the endpoint URL. Use of this webpage and the Gemma Web services, including the REST API, is subject to [these terms and conditions](https://pavlidislab.github.io/Gemma/terms.html). Please read these in full before continuing to use this webpage or any other part of the Gemma system. You can [consult the CHANGELOG.md file](https://gemma.msl.ubc.ca/resources/restapidocs/CHANGELOG.md) to view release notes and recent changes to the Gemma RESTful API. # noqa: E501
OpenAPI spec version: 2.7.4 Contact: pavlab-support@msl.ubc.ca Generated by: https://github.com/swagger-api/swagger-codegen.git
- class gemmapy.sdk.models.AnnotationSearchResultValueObject(value=None, value_uri=None, category=None, category_uri=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
AnnotationSearchResultValueObject - a model defined in Swagger
- attribute_map = {'category': 'category', 'category_uri': 'categoryUri', 'value': 'value', 'value_uri': 'valueUri'}¶
- property category¶
Gets the category of this AnnotationSearchResultValueObject. # noqa: E501
- Returns:
The category of this AnnotationSearchResultValueObject. # noqa: E501
- Return type:
str
- property category_uri¶
Gets the category_uri of this AnnotationSearchResultValueObject. # noqa: E501
- Returns:
The category_uri of this AnnotationSearchResultValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'category': 'str', 'category_uri': 'str', 'value': 'str', 'value_uri': 'str'}¶
- property value¶
Gets the value of this AnnotationSearchResultValueObject. # noqa: E501
- Returns:
The value of this AnnotationSearchResultValueObject. # noqa: E501
- Return type:
str
- property value_uri¶
Gets the value_uri of this AnnotationSearchResultValueObject. # noqa: E501
- Returns:
The value_uri of this AnnotationSearchResultValueObject. # noqa: E501
- Return type:
str
- class gemmapy.sdk.models.AnnotationValueObject(id=None, class_uri=None, class_name=None, term_uri=None, term_name=None, evidence_code=None, object_class=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
AnnotationValueObject - a model defined in Swagger
- attribute_map = {'class_name': 'className', 'class_uri': 'classUri', 'evidence_code': 'evidenceCode', 'id': 'id', 'object_class': 'objectClass', 'term_name': 'termName', 'term_uri': 'termUri'}¶
- property class_name¶
Gets the class_name of this AnnotationValueObject. # noqa: E501
- Returns:
The class_name of this AnnotationValueObject. # noqa: E501
- Return type:
str
- property class_uri¶
Gets the class_uri of this AnnotationValueObject. # noqa: E501
- Returns:
The class_uri of this AnnotationValueObject. # noqa: E501
- Return type:
str
- property evidence_code¶
Gets the evidence_code of this AnnotationValueObject. # noqa: E501
- Returns:
The evidence_code of this AnnotationValueObject. # noqa: E501
- Return type:
str
- property id¶
Gets the id of this AnnotationValueObject. # noqa: E501
- Returns:
The id of this AnnotationValueObject. # noqa: E501
- Return type:
int
- property object_class¶
Gets the object_class of this AnnotationValueObject. # noqa: E501
- Returns:
The object_class of this AnnotationValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'class_name': 'str', 'class_uri': 'str', 'evidence_code': 'str', 'id': 'int', 'object_class': 'str', 'term_name': 'str', 'term_uri': 'str'}¶
- property term_name¶
Gets the term_name of this AnnotationValueObject. # noqa: E501
- Returns:
The term_name of this AnnotationValueObject. # noqa: E501
- Return type:
str
- property term_uri¶
Gets the term_uri of this AnnotationValueObject. # noqa: E501
- Returns:
The term_uri of this AnnotationValueObject. # noqa: E501
- Return type:
str
- class gemmapy.sdk.models.AnnotationWithUsageStatisticsValueObject(class_uri=None, class_name=None, term_uri=None, term_name=None, evidence_code=None, number_of_expression_experiments=None, parent_terms=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
AnnotationWithUsageStatisticsValueObject - a model defined in Swagger
- attribute_map = {'class_name': 'className', 'class_uri': 'classUri', 'evidence_code': 'evidenceCode', 'number_of_expression_experiments': 'numberOfExpressionExperiments', 'parent_terms': 'parentTerms', 'term_name': 'termName', 'term_uri': 'termUri'}¶
- property class_name¶
Gets the class_name of this AnnotationWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The class_name of this AnnotationWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property class_uri¶
Gets the class_uri of this AnnotationWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The class_uri of this AnnotationWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property evidence_code¶
Gets the evidence_code of this AnnotationWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The evidence_code of this AnnotationWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property number_of_expression_experiments¶
Gets the number_of_expression_experiments of this AnnotationWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The number_of_expression_experiments of this AnnotationWithUsageStatisticsValueObject. # noqa: E501
- Return type:
int
- property parent_terms¶
Gets the parent_terms of this AnnotationWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The parent_terms of this AnnotationWithUsageStatisticsValueObject. # noqa: E501
- Return type:
list[OntologyTermValueObject]
- swagger_types = {'class_name': 'str', 'class_uri': 'str', 'evidence_code': 'str', 'number_of_expression_experiments': 'int', 'parent_terms': 'list[OntologyTermValueObject]', 'term_name': 'str', 'term_uri': 'str'}¶
- property term_name¶
Gets the term_name of this AnnotationWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The term_name of this AnnotationWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property term_uri¶
Gets the term_uri of this AnnotationWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The term_uri of this AnnotationWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- class gemmapy.sdk.models.ApiInfoValueObject(welcome=None, version=None, docs=None, external_databases=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ApiInfoValueObject - a model defined in Swagger
- attribute_map = {'docs': 'docs', 'external_databases': 'externalDatabases', 'version': 'version', 'welcome': 'welcome'}¶
- property docs¶
Gets the docs of this ApiInfoValueObject. # noqa: E501
- Returns:
The docs of this ApiInfoValueObject. # noqa: E501
- Return type:
str
- property external_databases¶
Gets the external_databases of this ApiInfoValueObject. # noqa: E501
- Returns:
The external_databases of this ApiInfoValueObject. # noqa: E501
- Return type:
- swagger_types = {'docs': 'str', 'external_databases': 'list[ExternalDatabaseValueObject]', 'version': 'str', 'welcome': 'str'}¶
- property version¶
Gets the version of this ApiInfoValueObject. # noqa: E501
- Returns:
The version of this ApiInfoValueObject. # noqa: E501
- Return type:
str
- property welcome¶
Gets the welcome of this ApiInfoValueObject. # noqa: E501
- Returns:
The welcome of this ApiInfoValueObject. # noqa: E501
- Return type:
str
- class gemmapy.sdk.models.ArrayDesignValueObject(id=None, last_updated=None, troubled=None, last_troubled_event=None, needs_attention=None, last_needs_attention_event=None, curation_note=None, last_note_update_event=None, color=None, description=None, expression_experiment_count=None, is_merged=None, is_mergee=None, name=None, short_name=None, technology_type=None, release_version=None, release_url=None, external_references=None, taxon_id=None, number_of_expression_experiments=None, trouble_details=None, number_of_switched_expression_experiments=None, taxon=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ArrayDesignValueObject - a model defined in Swagger
- attribute_map = {'color': 'color', 'curation_note': 'curationNote', 'description': 'description', 'expression_experiment_count': 'expressionExperimentCount', 'external_references': 'externalReferences', 'id': 'id', 'is_merged': 'isMerged', 'is_mergee': 'isMergee', 'last_needs_attention_event': 'lastNeedsAttentionEvent', 'last_note_update_event': 'lastNoteUpdateEvent', 'last_troubled_event': 'lastTroubledEvent', 'last_updated': 'lastUpdated', 'name': 'name', 'needs_attention': 'needsAttention', 'number_of_expression_experiments': 'numberOfExpressionExperiments', 'number_of_switched_expression_experiments': 'numberOfSwitchedExpressionExperiments', 'release_url': 'releaseUrl', 'release_version': 'releaseVersion', 'short_name': 'shortName', 'taxon': 'taxon', 'taxon_id': 'taxonID', 'technology_type': 'technologyType', 'trouble_details': 'troubleDetails', 'troubled': 'troubled'}¶
- property color¶
Gets the color of this ArrayDesignValueObject. # noqa: E501
- Returns:
The color of this ArrayDesignValueObject. # noqa: E501
- Return type:
str
- property curation_note¶
Gets the curation_note of this ArrayDesignValueObject. # noqa: E501
- Returns:
The curation_note of this ArrayDesignValueObject. # noqa: E501
- Return type:
str
- property description¶
Gets the description of this ArrayDesignValueObject. # noqa: E501
- Returns:
The description of this ArrayDesignValueObject. # noqa: E501
- Return type:
str
- property expression_experiment_count¶
Gets the expression_experiment_count of this ArrayDesignValueObject. # noqa: E501
- Returns:
The expression_experiment_count of this ArrayDesignValueObject. # noqa: E501
- Return type:
int
- property external_references¶
Gets the external_references of this ArrayDesignValueObject. # noqa: E501
- Returns:
The external_references of this ArrayDesignValueObject. # noqa: E501
- Return type:
list[DatabaseEntryValueObject]
- property id¶
Gets the id of this ArrayDesignValueObject. # noqa: E501
- Returns:
The id of this ArrayDesignValueObject. # noqa: E501
- Return type:
int
- property is_merged¶
Gets the is_merged of this ArrayDesignValueObject. # noqa: E501
- Returns:
The is_merged of this ArrayDesignValueObject. # noqa: E501
- Return type:
bool
- property is_mergee¶
Gets the is_mergee of this ArrayDesignValueObject. # noqa: E501
- Returns:
The is_mergee of this ArrayDesignValueObject. # noqa: E501
- Return type:
bool
- property last_needs_attention_event¶
Gets the last_needs_attention_event of this ArrayDesignValueObject. # noqa: E501
- Returns:
The last_needs_attention_event of this ArrayDesignValueObject. # noqa: E501
- Return type:
- property last_note_update_event¶
Gets the last_note_update_event of this ArrayDesignValueObject. # noqa: E501
- Returns:
The last_note_update_event of this ArrayDesignValueObject. # noqa: E501
- Return type:
- property last_troubled_event¶
Gets the last_troubled_event of this ArrayDesignValueObject. # noqa: E501
- Returns:
The last_troubled_event of this ArrayDesignValueObject. # noqa: E501
- Return type:
- property last_updated¶
Gets the last_updated of this ArrayDesignValueObject. # noqa: E501
- Returns:
The last_updated of this ArrayDesignValueObject. # noqa: E501
- Return type:
datetime
- property name¶
Gets the name of this ArrayDesignValueObject. # noqa: E501
- Returns:
The name of this ArrayDesignValueObject. # noqa: E501
- Return type:
str
- property needs_attention¶
Gets the needs_attention of this ArrayDesignValueObject. # noqa: E501
- Returns:
The needs_attention of this ArrayDesignValueObject. # noqa: E501
- Return type:
bool
- property number_of_expression_experiments¶
Gets the number_of_expression_experiments of this ArrayDesignValueObject. # noqa: E501
- Returns:
The number_of_expression_experiments of this ArrayDesignValueObject. # noqa: E501
- Return type:
int
- property number_of_switched_expression_experiments¶
Gets the number_of_switched_expression_experiments of this ArrayDesignValueObject. # noqa: E501
- Returns:
The number_of_switched_expression_experiments of this ArrayDesignValueObject. # noqa: E501
- Return type:
int
- property release_url¶
Gets the release_url of this ArrayDesignValueObject. # noqa: E501
- Returns:
The release_url of this ArrayDesignValueObject. # noqa: E501
- Return type:
str
- property release_version¶
Gets the release_version of this ArrayDesignValueObject. # noqa: E501
- Returns:
The release_version of this ArrayDesignValueObject. # noqa: E501
- Return type:
str
- property short_name¶
Gets the short_name of this ArrayDesignValueObject. # noqa: E501
- Returns:
The short_name of this ArrayDesignValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'color': 'str', 'curation_note': 'str', 'description': 'str', 'expression_experiment_count': 'int', 'external_references': 'list[DatabaseEntryValueObject]', 'id': 'int', 'is_merged': 'bool', 'is_mergee': 'bool', 'last_needs_attention_event': 'AuditEventValueObject', 'last_note_update_event': 'AuditEventValueObject', 'last_troubled_event': 'AuditEventValueObject', 'last_updated': 'datetime', 'name': 'str', 'needs_attention': 'bool', 'number_of_expression_experiments': 'int', 'number_of_switched_expression_experiments': 'int', 'release_url': 'str', 'release_version': 'str', 'short_name': 'str', 'taxon': 'TaxonValueObject', 'taxon_id': 'int', 'technology_type': 'str', 'trouble_details': 'str', 'troubled': 'bool'}¶
- property taxon¶
Gets the taxon of this ArrayDesignValueObject. # noqa: E501
- Returns:
The taxon of this ArrayDesignValueObject. # noqa: E501
- Return type:
- property taxon_id¶
Gets the taxon_id of this ArrayDesignValueObject. # noqa: E501
- Returns:
The taxon_id of this ArrayDesignValueObject. # noqa: E501
- Return type:
int
- property technology_type¶
Gets the technology_type of this ArrayDesignValueObject. # noqa: E501
- Returns:
The technology_type of this ArrayDesignValueObject. # noqa: E501
- Return type:
str
- property trouble_details¶
Gets the trouble_details of this ArrayDesignValueObject. # noqa: E501
- Returns:
The trouble_details of this ArrayDesignValueObject. # noqa: E501
- Return type:
str
- property troubled¶
Gets the troubled of this ArrayDesignValueObject. # noqa: E501
- Returns:
The troubled of this ArrayDesignValueObject. # noqa: E501
- Return type:
bool
- class gemmapy.sdk.models.ArrayDesignWithUsageStatisticsValueObject(id=None, last_updated=None, troubled=None, last_troubled_event=None, needs_attention=None, last_needs_attention_event=None, curation_note=None, last_note_update_event=None, color=None, description=None, is_merged=None, is_mergee=None, name=None, short_name=None, technology_type=None, release_version=None, release_url=None, external_references=None, number_of_expression_experiments_for_technology_type=None, number_of_expression_experiments=None, taxon_id=None, trouble_details=None, taxon=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ArrayDesignWithUsageStatisticsValueObject - a model defined in Swagger
- attribute_map = {'color': 'color', 'curation_note': 'curationNote', 'description': 'description', 'external_references': 'externalReferences', 'id': 'id', 'is_merged': 'isMerged', 'is_mergee': 'isMergee', 'last_needs_attention_event': 'lastNeedsAttentionEvent', 'last_note_update_event': 'lastNoteUpdateEvent', 'last_troubled_event': 'lastTroubledEvent', 'last_updated': 'lastUpdated', 'name': 'name', 'needs_attention': 'needsAttention', 'number_of_expression_experiments': 'numberOfExpressionExperiments', 'number_of_expression_experiments_for_technology_type': 'numberOfExpressionExperimentsForTechnologyType', 'release_url': 'releaseUrl', 'release_version': 'releaseVersion', 'short_name': 'shortName', 'taxon': 'taxon', 'taxon_id': 'taxonID', 'technology_type': 'technologyType', 'trouble_details': 'troubleDetails', 'troubled': 'troubled'}¶
- property color¶
Gets the color of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The color of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property curation_note¶
Gets the curation_note of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The curation_note of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property description¶
Gets the description of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The description of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property external_references¶
Gets the external_references of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The external_references of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
list[DatabaseEntryValueObject]
- property id¶
Gets the id of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The id of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
int
- property is_merged¶
Gets the is_merged of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The is_merged of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
bool
- property is_mergee¶
Gets the is_mergee of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The is_mergee of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
bool
- property last_needs_attention_event¶
Gets the last_needs_attention_event of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The last_needs_attention_event of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
- property last_note_update_event¶
Gets the last_note_update_event of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The last_note_update_event of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
- property last_troubled_event¶
Gets the last_troubled_event of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The last_troubled_event of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
- property last_updated¶
Gets the last_updated of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The last_updated of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
datetime
- property name¶
Gets the name of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The name of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property needs_attention¶
Gets the needs_attention of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The needs_attention of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
bool
- property number_of_expression_experiments¶
Gets the number_of_expression_experiments of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The number_of_expression_experiments of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
int
- property number_of_expression_experiments_for_technology_type¶
Gets the number_of_expression_experiments_for_technology_type of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The number_of_expression_experiments_for_technology_type of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
int
- property release_url¶
Gets the release_url of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The release_url of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property release_version¶
Gets the release_version of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The release_version of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property short_name¶
Gets the short_name of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The short_name of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'color': 'str', 'curation_note': 'str', 'description': 'str', 'external_references': 'list[DatabaseEntryValueObject]', 'id': 'int', 'is_merged': 'bool', 'is_mergee': 'bool', 'last_needs_attention_event': 'AuditEventValueObject', 'last_note_update_event': 'AuditEventValueObject', 'last_troubled_event': 'AuditEventValueObject', 'last_updated': 'datetime', 'name': 'str', 'needs_attention': 'bool', 'number_of_expression_experiments': 'int', 'number_of_expression_experiments_for_technology_type': 'int', 'release_url': 'str', 'release_version': 'str', 'short_name': 'str', 'taxon': 'TaxonValueObject', 'taxon_id': 'int', 'technology_type': 'str', 'trouble_details': 'str', 'troubled': 'bool'}¶
- property taxon¶
Gets the taxon of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The taxon of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
- property taxon_id¶
Gets the taxon_id of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The taxon_id of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
int
- property technology_type¶
Gets the technology_type of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The technology_type of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property trouble_details¶
Gets the trouble_details of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The trouble_details of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property troubled¶
Gets the troubled of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The troubled of this ArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
bool
- class gemmapy.sdk.models.AuditEventValueObject(id=None, performer=None, _date=None, action=None, note=None, detail=None, event_type_name=None, action_name=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
AuditEventValueObject - a model defined in Swagger
- property action¶
Gets the action of this AuditEventValueObject. # noqa: E501
- Returns:
The action of this AuditEventValueObject. # noqa: E501
- Return type:
str
- property action_name¶
Gets the action_name of this AuditEventValueObject. # noqa: E501
- Returns:
The action_name of this AuditEventValueObject. # noqa: E501
- Return type:
str
- attribute_map = {'_date': 'date', 'action': 'action', 'action_name': 'actionName', 'detail': 'detail', 'event_type_name': 'eventTypeName', 'id': 'id', 'note': 'note', 'performer': 'performer'}¶
- property detail¶
Gets the detail of this AuditEventValueObject. # noqa: E501
- Returns:
The detail of this AuditEventValueObject. # noqa: E501
- Return type:
str
- property event_type_name¶
Gets the event_type_name of this AuditEventValueObject. # noqa: E501
- Returns:
The event_type_name of this AuditEventValueObject. # noqa: E501
- Return type:
str
- property id¶
Gets the id of this AuditEventValueObject. # noqa: E501
- Returns:
The id of this AuditEventValueObject. # noqa: E501
- Return type:
int
- property note¶
Gets the note of this AuditEventValueObject. # noqa: E501
- Returns:
The note of this AuditEventValueObject. # noqa: E501
- Return type:
str
- property performer¶
Gets the performer of this AuditEventValueObject. # noqa: E501
- Returns:
The performer of this AuditEventValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'_date': 'datetime', 'action': 'str', 'action_name': 'str', 'detail': 'str', 'event_type_name': 'str', 'id': 'int', 'note': 'str', 'performer': 'str'}¶
- class gemmapy.sdk.models.BibliographicPhenotypesValueObject(gene_ncbi=None, gene_name=None, evidence_id=None, phenotypes_values=None, all_id_of_phenotype=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
BibliographicPhenotypesValueObject - a model defined in Swagger
- property all_id_of_phenotype¶
Gets the all_id_of_phenotype of this BibliographicPhenotypesValueObject. # noqa: E501
- Returns:
The all_id_of_phenotype of this BibliographicPhenotypesValueObject. # noqa: E501
- Return type:
list[int]
- attribute_map = {'all_id_of_phenotype': 'allIdOfPhenotype', 'evidence_id': 'evidenceId', 'gene_name': 'geneName', 'gene_ncbi': 'geneNCBI', 'phenotypes_values': 'phenotypesValues'}¶
- property evidence_id¶
Gets the evidence_id of this BibliographicPhenotypesValueObject. # noqa: E501
- Returns:
The evidence_id of this BibliographicPhenotypesValueObject. # noqa: E501
- Return type:
int
- property gene_name¶
Gets the gene_name of this BibliographicPhenotypesValueObject. # noqa: E501
- Returns:
The gene_name of this BibliographicPhenotypesValueObject. # noqa: E501
- Return type:
str
- property gene_ncbi¶
Gets the gene_ncbi of this BibliographicPhenotypesValueObject. # noqa: E501
- Returns:
The gene_ncbi of this BibliographicPhenotypesValueObject. # noqa: E501
- Return type:
int
- property phenotypes_values¶
Gets the phenotypes_values of this BibliographicPhenotypesValueObject. # noqa: E501
- Returns:
The phenotypes_values of this BibliographicPhenotypesValueObject. # noqa: E501
- Return type:
- swagger_types = {'all_id_of_phenotype': 'list[int]', 'evidence_id': 'int', 'gene_name': 'str', 'gene_ncbi': 'int', 'phenotypes_values': 'list[CharacteristicValueObject]'}¶
- class gemmapy.sdk.models.BibliographicReferenceValueObject(id=None, abstract_text=None, author_list=None, citation=None, experiments=None, issue=None, pages=None, pub_accession=None, publication=None, publication_date=None, publisher=None, title=None, volume=None, mesh_terms=None, chemicals_terms=None, bibliographic_phenotypes=None, retracted=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
BibliographicReferenceValueObject - a model defined in Swagger
- property abstract_text¶
Gets the abstract_text of this BibliographicReferenceValueObject. # noqa: E501
- Returns:
The abstract_text of this BibliographicReferenceValueObject. # noqa: E501
- Return type:
str
- attribute_map = {'abstract_text': 'abstractText', 'author_list': 'authorList', 'bibliographic_phenotypes': 'bibliographicPhenotypes', 'chemicals_terms': 'chemicalsTerms', 'citation': 'citation', 'experiments': 'experiments', 'id': 'id', 'issue': 'issue', 'mesh_terms': 'meshTerms', 'pages': 'pages', 'pub_accession': 'pubAccession', 'publication': 'publication', 'publication_date': 'publicationDate', 'publisher': 'publisher', 'retracted': 'retracted', 'title': 'title', 'volume': 'volume'}¶
- property author_list¶
Gets the author_list of this BibliographicReferenceValueObject. # noqa: E501
- Returns:
The author_list of this BibliographicReferenceValueObject. # noqa: E501
- Return type:
str
- property bibliographic_phenotypes¶
Gets the bibliographic_phenotypes of this BibliographicReferenceValueObject. # noqa: E501
- Returns:
The bibliographic_phenotypes of this BibliographicReferenceValueObject. # noqa: E501
- Return type:
- property chemicals_terms¶
Gets the chemicals_terms of this BibliographicReferenceValueObject. # noqa: E501
- Returns:
The chemicals_terms of this BibliographicReferenceValueObject. # noqa: E501
- Return type:
list[str]
- property citation¶
Gets the citation of this BibliographicReferenceValueObject. # noqa: E501
- Returns:
The citation of this BibliographicReferenceValueObject. # noqa: E501
- Return type:
- property experiments¶
Gets the experiments of this BibliographicReferenceValueObject. # noqa: E501
- Returns:
The experiments of this BibliographicReferenceValueObject. # noqa: E501
- Return type:
- property id¶
Gets the id of this BibliographicReferenceValueObject. # noqa: E501
- Returns:
The id of this BibliographicReferenceValueObject. # noqa: E501
- Return type:
int
- property issue¶
Gets the issue of this BibliographicReferenceValueObject. # noqa: E501
- Returns:
The issue of this BibliographicReferenceValueObject. # noqa: E501
- Return type:
str
- property mesh_terms¶
Gets the mesh_terms of this BibliographicReferenceValueObject. # noqa: E501
- Returns:
The mesh_terms of this BibliographicReferenceValueObject. # noqa: E501
- Return type:
list[str]
- property pages¶
Gets the pages of this BibliographicReferenceValueObject. # noqa: E501
- Returns:
The pages of this BibliographicReferenceValueObject. # noqa: E501
- Return type:
str
- property pub_accession¶
Gets the pub_accession of this BibliographicReferenceValueObject. # noqa: E501
- Returns:
The pub_accession of this BibliographicReferenceValueObject. # noqa: E501
- Return type:
str
- property publication¶
Gets the publication of this BibliographicReferenceValueObject. # noqa: E501
- Returns:
The publication of this BibliographicReferenceValueObject. # noqa: E501
- Return type:
str
- property publication_date¶
Gets the publication_date of this BibliographicReferenceValueObject. # noqa: E501
- Returns:
The publication_date of this BibliographicReferenceValueObject. # noqa: E501
- Return type:
datetime
- property publisher¶
Gets the publisher of this BibliographicReferenceValueObject. # noqa: E501
- Returns:
The publisher of this BibliographicReferenceValueObject. # noqa: E501
- Return type:
str
- property retracted¶
Gets the retracted of this BibliographicReferenceValueObject. # noqa: E501
- Returns:
The retracted of this BibliographicReferenceValueObject. # noqa: E501
- Return type:
bool
- swagger_types = {'abstract_text': 'str', 'author_list': 'str', 'bibliographic_phenotypes': 'list[BibliographicPhenotypesValueObject]', 'chemicals_terms': 'list[str]', 'citation': 'CitationValueObject', 'experiments': 'list[ExpressionExperimentValueObject]', 'id': 'int', 'issue': 'str', 'mesh_terms': 'list[str]', 'pages': 'str', 'pub_accession': 'str', 'publication': 'str', 'publication_date': 'datetime', 'publisher': 'str', 'retracted': 'bool', 'title': 'str', 'volume': 'str'}¶
- property title¶
Gets the title of this BibliographicReferenceValueObject. # noqa: E501
- Returns:
The title of this BibliographicReferenceValueObject. # noqa: E501
- Return type:
str
- property volume¶
Gets the volume of this BibliographicReferenceValueObject. # noqa: E501
- Returns:
The volume of this BibliographicReferenceValueObject. # noqa: E501
- Return type:
str
- class gemmapy.sdk.models.BioAssayValueObject(id=None, accession=None, array_design=None, description=None, metadata=None, name=None, original_platform=None, outlier=None, predicted_outlier=None, processing_date=None, sample=None, sequence_paired_reads=None, sequence_read_count=None, sequence_read_length=None, user_flagged_outlier=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
BioAssayValueObject - a model defined in Swagger
- property accession¶
Gets the accession of this BioAssayValueObject. # noqa: E501
- Returns:
The accession of this BioAssayValueObject. # noqa: E501
- Return type:
- property array_design¶
Gets the array_design of this BioAssayValueObject. # noqa: E501
- Returns:
The array_design of this BioAssayValueObject. # noqa: E501
- Return type:
- attribute_map = {'accession': 'accession', 'array_design': 'arrayDesign', 'description': 'description', 'id': 'id', 'metadata': 'metadata', 'name': 'name', 'original_platform': 'originalPlatform', 'outlier': 'outlier', 'predicted_outlier': 'predictedOutlier', 'processing_date': 'processingDate', 'sample': 'sample', 'sequence_paired_reads': 'sequencePairedReads', 'sequence_read_count': 'sequenceReadCount', 'sequence_read_length': 'sequenceReadLength', 'user_flagged_outlier': 'userFlaggedOutlier'}¶
- property description¶
Gets the description of this BioAssayValueObject. # noqa: E501
- Returns:
The description of this BioAssayValueObject. # noqa: E501
- Return type:
str
- property id¶
Gets the id of this BioAssayValueObject. # noqa: E501
- Returns:
The id of this BioAssayValueObject. # noqa: E501
- Return type:
int
- property metadata¶
Gets the metadata of this BioAssayValueObject. # noqa: E501
- Returns:
The metadata of this BioAssayValueObject. # noqa: E501
- Return type:
str
- property name¶
Gets the name of this BioAssayValueObject. # noqa: E501
- Returns:
The name of this BioAssayValueObject. # noqa: E501
- Return type:
str
- property original_platform¶
Gets the original_platform of this BioAssayValueObject. # noqa: E501
- Returns:
The original_platform of this BioAssayValueObject. # noqa: E501
- Return type:
- property outlier¶
Gets the outlier of this BioAssayValueObject. # noqa: E501
- Returns:
The outlier of this BioAssayValueObject. # noqa: E501
- Return type:
bool
- property predicted_outlier¶
Gets the predicted_outlier of this BioAssayValueObject. # noqa: E501
- Returns:
The predicted_outlier of this BioAssayValueObject. # noqa: E501
- Return type:
bool
- property processing_date¶
Gets the processing_date of this BioAssayValueObject. # noqa: E501
- Returns:
The processing_date of this BioAssayValueObject. # noqa: E501
- Return type:
datetime
- property sample¶
Gets the sample of this BioAssayValueObject. # noqa: E501
- Returns:
The sample of this BioAssayValueObject. # noqa: E501
- Return type:
- property sequence_paired_reads¶
Gets the sequence_paired_reads of this BioAssayValueObject. # noqa: E501
- Returns:
The sequence_paired_reads of this BioAssayValueObject. # noqa: E501
- Return type:
bool
- property sequence_read_count¶
Gets the sequence_read_count of this BioAssayValueObject. # noqa: E501
- Returns:
The sequence_read_count of this BioAssayValueObject. # noqa: E501
- Return type:
int
- property sequence_read_length¶
Gets the sequence_read_length of this BioAssayValueObject. # noqa: E501
- Returns:
The sequence_read_length of this BioAssayValueObject. # noqa: E501
- Return type:
int
- swagger_types = {'accession': 'DatabaseEntryValueObject', 'array_design': 'ArrayDesignValueObject', 'description': 'str', 'id': 'int', 'metadata': 'str', 'name': 'str', 'original_platform': 'ArrayDesignValueObject', 'outlier': 'bool', 'predicted_outlier': 'bool', 'processing_date': 'datetime', 'sample': 'BioMaterialValueObject', 'sequence_paired_reads': 'bool', 'sequence_read_count': 'int', 'sequence_read_length': 'int', 'user_flagged_outlier': 'bool'}¶
- property user_flagged_outlier¶
Gets the user_flagged_outlier of this BioAssayValueObject. # noqa: E501
- Returns:
The user_flagged_outlier of this BioAssayValueObject. # noqa: E501
- Return type:
bool
- class gemmapy.sdk.models.BioMaterialValueObject(id=None, name=None, description=None, bio_assay_ids=None, characteristics=None, factors=None, factor_value_objects=None, factor_values=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
BioMaterialValueObject - a model defined in Swagger
- attribute_map = {'bio_assay_ids': 'bioAssayIds', 'characteristics': 'characteristics', 'description': 'description', 'factor_value_objects': 'factorValueObjects', 'factor_values': 'factorValues', 'factors': 'factors', 'id': 'id', 'name': 'name'}¶
- property bio_assay_ids¶
Gets the bio_assay_ids of this BioMaterialValueObject. # noqa: E501
- Returns:
The bio_assay_ids of this BioMaterialValueObject. # noqa: E501
- Return type:
list[int]
- property characteristics¶
Gets the characteristics of this BioMaterialValueObject. # noqa: E501
- Returns:
The characteristics of this BioMaterialValueObject. # noqa: E501
- Return type:
- property description¶
Gets the description of this BioMaterialValueObject. # noqa: E501
- Returns:
The description of this BioMaterialValueObject. # noqa: E501
- Return type:
str
- property factor_value_objects¶
Gets the factor_value_objects of this BioMaterialValueObject. # noqa: E501
This property is redundant, use factorValues instead. # noqa: E501
- Returns:
The factor_value_objects of this BioMaterialValueObject. # noqa: E501
- Return type:
- property factor_values¶
Gets the factor_values of this BioMaterialValueObject. # noqa: E501
- Returns:
The factor_values of this BioMaterialValueObject. # noqa: E501
- Return type:
- property factors¶
Gets the factors of this BioMaterialValueObject. # noqa: E501
This is deprecated, use the factorValues collection instead. # noqa: E501
- Returns:
The factors of this BioMaterialValueObject. # noqa: E501
- Return type:
dict(str, str)
- property id¶
Gets the id of this BioMaterialValueObject. # noqa: E501
- Returns:
The id of this BioMaterialValueObject. # noqa: E501
- Return type:
int
- property name¶
Gets the name of this BioMaterialValueObject. # noqa: E501
- Returns:
The name of this BioMaterialValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'bio_assay_ids': 'list[int]', 'characteristics': 'list[CharacteristicValueObject]', 'description': 'str', 'factor_value_objects': 'list[FactorValueBasicValueObject]', 'factor_values': 'list[FactorValueBasicValueObject]', 'factors': 'dict(str, str)', 'id': 'int', 'name': 'str'}¶
- class gemmapy.sdk.models.BioSequenceValueObject(id=None, description=None, fraction_repeats=None, length=None, name=None, sequence=None, sequence_database_entry=None, taxon=None, type=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
BioSequenceValueObject - a model defined in Swagger
- attribute_map = {'description': 'description', 'fraction_repeats': 'fractionRepeats', 'id': 'id', 'length': 'length', 'name': 'name', 'sequence': 'sequence', 'sequence_database_entry': 'sequenceDatabaseEntry', 'taxon': 'taxon', 'type': 'type'}¶
- property description¶
Gets the description of this BioSequenceValueObject. # noqa: E501
- Returns:
The description of this BioSequenceValueObject. # noqa: E501
- Return type:
str
- property fraction_repeats¶
Gets the fraction_repeats of this BioSequenceValueObject. # noqa: E501
- Returns:
The fraction_repeats of this BioSequenceValueObject. # noqa: E501
- Return type:
float
- property id¶
Gets the id of this BioSequenceValueObject. # noqa: E501
- Returns:
The id of this BioSequenceValueObject. # noqa: E501
- Return type:
int
- property length¶
Gets the length of this BioSequenceValueObject. # noqa: E501
- Returns:
The length of this BioSequenceValueObject. # noqa: E501
- Return type:
int
- property name¶
Gets the name of this BioSequenceValueObject. # noqa: E501
- Returns:
The name of this BioSequenceValueObject. # noqa: E501
- Return type:
str
- property sequence¶
Gets the sequence of this BioSequenceValueObject. # noqa: E501
- Returns:
The sequence of this BioSequenceValueObject. # noqa: E501
- Return type:
str
- property sequence_database_entry¶
Gets the sequence_database_entry of this BioSequenceValueObject. # noqa: E501
- Returns:
The sequence_database_entry of this BioSequenceValueObject. # noqa: E501
- Return type:
- swagger_types = {'description': 'str', 'fraction_repeats': 'float', 'id': 'int', 'length': 'int', 'name': 'str', 'sequence': 'str', 'sequence_database_entry': 'DatabaseEntryValueObject', 'taxon': 'TaxonValueObject', 'type': 'str'}¶
- property taxon¶
Gets the taxon of this BioSequenceValueObject. # noqa: E501
- Returns:
The taxon of this BioSequenceValueObject. # noqa: E501
- Return type:
- property type¶
Gets the type of this BioSequenceValueObject. # noqa: E501
- Returns:
The type of this BioSequenceValueObject. # noqa: E501
- Return type:
str
- class gemmapy.sdk.models.CategoryWithUsageStatisticsValueObject(class_uri=None, class_name=None, number_of_expression_experiments=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
CategoryWithUsageStatisticsValueObject - a model defined in Swagger
- attribute_map = {'class_name': 'className', 'class_uri': 'classUri', 'number_of_expression_experiments': 'numberOfExpressionExperiments'}¶
- property class_name¶
Gets the class_name of this CategoryWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The class_name of this CategoryWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property class_uri¶
Gets the class_uri of this CategoryWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The class_uri of this CategoryWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property number_of_expression_experiments¶
Gets the number_of_expression_experiments of this CategoryWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The number_of_expression_experiments of this CategoryWithUsageStatisticsValueObject. # noqa: E501
- Return type:
int
- swagger_types = {'class_name': 'str', 'class_uri': 'str', 'number_of_expression_experiments': 'int'}¶
- class gemmapy.sdk.models.CharacteristicValueObject(id=None, category=None, category_uri=None, value=None, value_uri=None, value_id=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
CharacteristicValueObject - a model defined in Swagger
- attribute_map = {'category': 'category', 'category_uri': 'categoryUri', 'id': 'id', 'value': 'value', 'value_id': 'valueId', 'value_uri': 'valueUri'}¶
- property category¶
Gets the category of this CharacteristicValueObject. # noqa: E501
- Returns:
The category of this CharacteristicValueObject. # noqa: E501
- Return type:
str
- property category_uri¶
Gets the category_uri of this CharacteristicValueObject. # noqa: E501
- Returns:
The category_uri of this CharacteristicValueObject. # noqa: E501
- Return type:
str
- property id¶
Gets the id of this CharacteristicValueObject. # noqa: E501
- Returns:
The id of this CharacteristicValueObject. # noqa: E501
- Return type:
int
- swagger_types = {'category': 'str', 'category_uri': 'str', 'id': 'int', 'value': 'str', 'value_id': 'str', 'value_uri': 'str'}¶
- property value¶
Gets the value of this CharacteristicValueObject. # noqa: E501
- Returns:
The value of this CharacteristicValueObject. # noqa: E501
- Return type:
str
- property value_id¶
Gets the value_id of this CharacteristicValueObject. # noqa: E501
- Returns:
The value_id of this CharacteristicValueObject. # noqa: E501
- Return type:
str
- property value_uri¶
Gets the value_uri of this CharacteristicValueObject. # noqa: E501
- Returns:
The value_uri of this CharacteristicValueObject. # noqa: E501
- Return type:
str
- class gemmapy.sdk.models.CitationValueObject(citation=None, id=None, pubmed_accession=None, pubmed_url=None, retracted=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
CitationValueObject - a model defined in Swagger
- attribute_map = {'citation': 'citation', 'id': 'id', 'pubmed_accession': 'pubmedAccession', 'pubmed_url': 'pubmedURL', 'retracted': 'retracted'}¶
- property citation¶
Gets the citation of this CitationValueObject. # noqa: E501
- Returns:
The citation of this CitationValueObject. # noqa: E501
- Return type:
str
- property id¶
Gets the id of this CitationValueObject. # noqa: E501
- Returns:
The id of this CitationValueObject. # noqa: E501
- Return type:
int
- property pubmed_accession¶
Gets the pubmed_accession of this CitationValueObject. # noqa: E501
- Returns:
The pubmed_accession of this CitationValueObject. # noqa: E501
- Return type:
str
- property pubmed_url¶
Gets the pubmed_url of this CitationValueObject. # noqa: E501
- Returns:
The pubmed_url of this CitationValueObject. # noqa: E501
- Return type:
str
- property retracted¶
Gets the retracted of this CitationValueObject. # noqa: E501
- Returns:
The retracted of this CitationValueObject. # noqa: E501
- Return type:
bool
- swagger_types = {'citation': 'str', 'id': 'int', 'pubmed_accession': 'str', 'pubmed_url': 'str', 'retracted': 'bool'}¶
- class gemmapy.sdk.models.CompositeSequenceArg[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
CompositeSequenceArg - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.CompositeSequenceValueObject(id=None, name=None, description=None, array_design=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
CompositeSequenceValueObject - a model defined in Swagger
- property array_design¶
Gets the array_design of this CompositeSequenceValueObject. # noqa: E501
- Returns:
The array_design of this CompositeSequenceValueObject. # noqa: E501
- Return type:
- attribute_map = {'array_design': 'arrayDesign', 'description': 'description', 'id': 'id', 'name': 'name'}¶
- property description¶
Gets the description of this CompositeSequenceValueObject. # noqa: E501
- Returns:
The description of this CompositeSequenceValueObject. # noqa: E501
- Return type:
str
- property id¶
Gets the id of this CompositeSequenceValueObject. # noqa: E501
- Returns:
The id of this CompositeSequenceValueObject. # noqa: E501
- Return type:
int
- property name¶
Gets the name of this CompositeSequenceValueObject. # noqa: E501
- Returns:
The name of this CompositeSequenceValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'array_design': 'ArrayDesignValueObject', 'description': 'str', 'id': 'int', 'name': 'str'}¶
- class gemmapy.sdk.models.ContrastResultValueObject(id=None, pvalue=None, coefficient=None, log_fold_change=None, factor_value=None, second_factor_value=None, tstat=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ContrastResultValueObject - a model defined in Swagger
- attribute_map = {'coefficient': 'coefficient', 'factor_value': 'factorValue', 'id': 'id', 'log_fold_change': 'logFoldChange', 'pvalue': 'pvalue', 'second_factor_value': 'secondFactorValue', 'tstat': 'tstat'}¶
- property coefficient¶
Gets the coefficient of this ContrastResultValueObject. # noqa: E501
- Returns:
The coefficient of this ContrastResultValueObject. # noqa: E501
- Return type:
float
- property factor_value¶
Gets the factor_value of this ContrastResultValueObject. # noqa: E501
- Returns:
The factor_value of this ContrastResultValueObject. # noqa: E501
- Return type:
- property id¶
Gets the id of this ContrastResultValueObject. # noqa: E501
- Returns:
The id of this ContrastResultValueObject. # noqa: E501
- Return type:
int
- property log_fold_change¶
Gets the log_fold_change of this ContrastResultValueObject. # noqa: E501
- Returns:
The log_fold_change of this ContrastResultValueObject. # noqa: E501
- Return type:
float
- property pvalue¶
Gets the pvalue of this ContrastResultValueObject. # noqa: E501
- Returns:
The pvalue of this ContrastResultValueObject. # noqa: E501
- Return type:
float
- property second_factor_value¶
Gets the second_factor_value of this ContrastResultValueObject. # noqa: E501
- Returns:
The second_factor_value of this ContrastResultValueObject. # noqa: E501
- Return type:
- swagger_types = {'coefficient': 'float', 'factor_value': 'FactorValueBasicValueObject', 'id': 'int', 'log_fold_change': 'float', 'pvalue': 'float', 'second_factor_value': 'FactorValueBasicValueObject', 'tstat': 'float'}¶
- property tstat¶
Gets the tstat of this ContrastResultValueObject. # noqa: E501
- Returns:
The tstat of this ContrastResultValueObject. # noqa: E501
- Return type:
float
- class gemmapy.sdk.models.DatabaseEntryArg[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
DatabaseEntryArg - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.DatabaseEntryValueObject(id=None, accession=None, external_database=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
DatabaseEntryValueObject - a model defined in Swagger
- property accession¶
Gets the accession of this DatabaseEntryValueObject. # noqa: E501
- Returns:
The accession of this DatabaseEntryValueObject. # noqa: E501
- Return type:
str
- attribute_map = {'accession': 'accession', 'external_database': 'externalDatabase', 'id': 'id'}¶
- property external_database¶
Gets the external_database of this DatabaseEntryValueObject. # noqa: E501
- Returns:
The external_database of this DatabaseEntryValueObject. # noqa: E501
- Return type:
- property id¶
Gets the id of this DatabaseEntryValueObject. # noqa: E501
- Returns:
The id of this DatabaseEntryValueObject. # noqa: E501
- Return type:
int
- swagger_types = {'accession': 'str', 'external_database': 'ExternalDatabaseValueObject', 'id': 'int'}¶
- class gemmapy.sdk.models.Dataset[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Dataset - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Dataset1[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Dataset1 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Dataset10[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Dataset10 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Dataset2[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Dataset2 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Dataset3[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Dataset3 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Dataset4[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Dataset4 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Dataset5[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Dataset5 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Dataset6[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Dataset6 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Dataset7[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Dataset7 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Dataset8[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Dataset8 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Dataset9[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Dataset9 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.DatasetArg[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
DatasetArg - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.DiffExResultSetSummaryValueObject(id=None, array_designs_used=None, baseline_group=None, experimental_factors=None, number_of_genes_analyzed=None, number_of_probes_analyzed=None, threshold=None, number_of_diff_expressed_probes=None, upregulated_count=None, downregulated_count=None, number_of_upregulated_probes=None, number_of_downregulated_probes=None, qvalue=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
DiffExResultSetSummaryValueObject - a model defined in Swagger
- property array_designs_used¶
Gets the array_designs_used of this DiffExResultSetSummaryValueObject. # noqa: E501
- Returns:
The array_designs_used of this DiffExResultSetSummaryValueObject. # noqa: E501
- Return type:
list[int]
- attribute_map = {'array_designs_used': 'arrayDesignsUsed', 'baseline_group': 'baselineGroup', 'downregulated_count': 'downregulatedCount', 'experimental_factors': 'experimentalFactors', 'id': 'id', 'number_of_diff_expressed_probes': 'numberOfDiffExpressedProbes', 'number_of_downregulated_probes': 'numberOfDownregulatedProbes', 'number_of_genes_analyzed': 'numberOfGenesAnalyzed', 'number_of_probes_analyzed': 'numberOfProbesAnalyzed', 'number_of_upregulated_probes': 'numberOfUpregulatedProbes', 'qvalue': 'qvalue', 'threshold': 'threshold', 'upregulated_count': 'upregulatedCount'}¶
- property baseline_group¶
Gets the baseline_group of this DiffExResultSetSummaryValueObject. # noqa: E501
- Returns:
The baseline_group of this DiffExResultSetSummaryValueObject. # noqa: E501
- Return type:
- property downregulated_count¶
Gets the downregulated_count of this DiffExResultSetSummaryValueObject. # noqa: E501
- Returns:
The downregulated_count of this DiffExResultSetSummaryValueObject. # noqa: E501
- Return type:
int
- property experimental_factors¶
Gets the experimental_factors of this DiffExResultSetSummaryValueObject. # noqa: E501
- Returns:
The experimental_factors of this DiffExResultSetSummaryValueObject. # noqa: E501
- Return type:
- property id¶
Gets the id of this DiffExResultSetSummaryValueObject. # noqa: E501
- Returns:
The id of this DiffExResultSetSummaryValueObject. # noqa: E501
- Return type:
int
- property number_of_diff_expressed_probes¶
Gets the number_of_diff_expressed_probes of this DiffExResultSetSummaryValueObject. # noqa: E501
- Returns:
The number_of_diff_expressed_probes of this DiffExResultSetSummaryValueObject. # noqa: E501
- Return type:
int
- property number_of_downregulated_probes¶
Gets the number_of_downregulated_probes of this DiffExResultSetSummaryValueObject. # noqa: E501
- Returns:
The number_of_downregulated_probes of this DiffExResultSetSummaryValueObject. # noqa: E501
- Return type:
int
- property number_of_genes_analyzed¶
Gets the number_of_genes_analyzed of this DiffExResultSetSummaryValueObject. # noqa: E501
- Returns:
The number_of_genes_analyzed of this DiffExResultSetSummaryValueObject. # noqa: E501
- Return type:
int
- property number_of_probes_analyzed¶
Gets the number_of_probes_analyzed of this DiffExResultSetSummaryValueObject. # noqa: E501
- Returns:
The number_of_probes_analyzed of this DiffExResultSetSummaryValueObject. # noqa: E501
- Return type:
int
- property number_of_upregulated_probes¶
Gets the number_of_upregulated_probes of this DiffExResultSetSummaryValueObject. # noqa: E501
- Returns:
The number_of_upregulated_probes of this DiffExResultSetSummaryValueObject. # noqa: E501
- Return type:
int
- property qvalue¶
Gets the qvalue of this DiffExResultSetSummaryValueObject. # noqa: E501
- Returns:
The qvalue of this DiffExResultSetSummaryValueObject. # noqa: E501
- Return type:
float
- swagger_types = {'array_designs_used': 'list[int]', 'baseline_group': 'FactorValueValueObject', 'downregulated_count': 'int', 'experimental_factors': 'list[ExperimentalFactorValueObject]', 'id': 'int', 'number_of_diff_expressed_probes': 'int', 'number_of_downregulated_probes': 'int', 'number_of_genes_analyzed': 'int', 'number_of_probes_analyzed': 'int', 'number_of_upregulated_probes': 'int', 'qvalue': 'float', 'threshold': 'float', 'upregulated_count': 'int'}¶
- property threshold¶
Gets the threshold of this DiffExResultSetSummaryValueObject. # noqa: E501
- Returns:
The threshold of this DiffExResultSetSummaryValueObject. # noqa: E501
- Return type:
float
- property upregulated_count¶
Gets the upregulated_count of this DiffExResultSetSummaryValueObject. # noqa: E501
- Returns:
The upregulated_count of this DiffExResultSetSummaryValueObject. # noqa: E501
- Return type:
int
- class gemmapy.sdk.models.DifferentialExpressionAnalysisResultSetValueObject(id=None, analysis=None, experimental_factors=None, baseline_group=None, results=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
DifferentialExpressionAnalysisResultSetValueObject - a model defined in Swagger
- property analysis¶
Gets the analysis of this DifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Returns:
The analysis of this DifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Return type:
- attribute_map = {'analysis': 'analysis', 'baseline_group': 'baselineGroup', 'experimental_factors': 'experimentalFactors', 'id': 'id', 'results': 'results'}¶
- property baseline_group¶
Gets the baseline_group of this DifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Returns:
The baseline_group of this DifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Return type:
- property experimental_factors¶
Gets the experimental_factors of this DifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Returns:
The experimental_factors of this DifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Return type:
- property id¶
Gets the id of this DifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Returns:
The id of this DifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Return type:
int
- property results¶
Gets the results of this DifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Returns:
The results of this DifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Return type:
- swagger_types = {'analysis': 'DifferentialExpressionAnalysisValueObject', 'baseline_group': 'FactorValueBasicValueObject', 'experimental_factors': 'list[ExperimentalFactorValueObject]', 'id': 'int', 'results': 'list[DifferentialExpressionAnalysisResultValueObject]'}¶
- class gemmapy.sdk.models.DifferentialExpressionAnalysisResultValueObject(id=None, probe_id=None, probe_name=None, genes=None, corrected_pvalue=None, rank=None, contrasts=None, pvalue=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
DifferentialExpressionAnalysisResultValueObject - a model defined in Swagger
- attribute_map = {'contrasts': 'contrasts', 'corrected_pvalue': 'correctedPvalue', 'genes': 'genes', 'id': 'id', 'probe_id': 'probeId', 'probe_name': 'probeName', 'pvalue': 'pvalue', 'rank': 'rank'}¶
- property contrasts¶
Gets the contrasts of this DifferentialExpressionAnalysisResultValueObject. # noqa: E501
- Returns:
The contrasts of this DifferentialExpressionAnalysisResultValueObject. # noqa: E501
- Return type:
- property corrected_pvalue¶
Gets the corrected_pvalue of this DifferentialExpressionAnalysisResultValueObject. # noqa: E501
- Returns:
The corrected_pvalue of this DifferentialExpressionAnalysisResultValueObject. # noqa: E501
- Return type:
float
- property genes¶
Gets the genes of this DifferentialExpressionAnalysisResultValueObject. # noqa: E501
- Returns:
The genes of this DifferentialExpressionAnalysisResultValueObject. # noqa: E501
- Return type:
list[GeneValueObject]
- property id¶
Gets the id of this DifferentialExpressionAnalysisResultValueObject. # noqa: E501
- Returns:
The id of this DifferentialExpressionAnalysisResultValueObject. # noqa: E501
- Return type:
int
- property probe_id¶
Gets the probe_id of this DifferentialExpressionAnalysisResultValueObject. # noqa: E501
- Returns:
The probe_id of this DifferentialExpressionAnalysisResultValueObject. # noqa: E501
- Return type:
int
- property probe_name¶
Gets the probe_name of this DifferentialExpressionAnalysisResultValueObject. # noqa: E501
- Returns:
The probe_name of this DifferentialExpressionAnalysisResultValueObject. # noqa: E501
- Return type:
str
- property pvalue¶
Gets the pvalue of this DifferentialExpressionAnalysisResultValueObject. # noqa: E501
- Returns:
The pvalue of this DifferentialExpressionAnalysisResultValueObject. # noqa: E501
- Return type:
float
- property rank¶
Gets the rank of this DifferentialExpressionAnalysisResultValueObject. # noqa: E501
- Returns:
The rank of this DifferentialExpressionAnalysisResultValueObject. # noqa: E501
- Return type:
float
- swagger_types = {'contrasts': 'list[ContrastResultValueObject]', 'corrected_pvalue': 'float', 'genes': 'list[GeneValueObject]', 'id': 'int', 'probe_id': 'int', 'probe_name': 'str', 'pvalue': 'float', 'rank': 'float'}¶
- class gemmapy.sdk.models.DifferentialExpressionAnalysisValueObject(id=None, factor_values_used=None, result_sets=None, array_designs_used=None, bio_assay_set_id=None, source_experiment=None, subset_factor=None, subset_factor_id=None, subset_factor_value=None, factor_values_used_by_experimental_factor_id=None, is_subset=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
DifferentialExpressionAnalysisValueObject - a model defined in Swagger
- property array_designs_used¶
Gets the array_designs_used of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Returns:
The array_designs_used of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Return type:
list[int]
- attribute_map = {'array_designs_used': 'arrayDesignsUsed', 'bio_assay_set_id': 'bioAssaySetId', 'factor_values_used': 'factorValuesUsed', 'factor_values_used_by_experimental_factor_id': 'factorValuesUsedByExperimentalFactorId', 'id': 'id', 'is_subset': 'isSubset', 'result_sets': 'resultSets', 'source_experiment': 'sourceExperiment', 'subset_factor': 'subsetFactor', 'subset_factor_id': 'subsetFactorId', 'subset_factor_value': 'subsetFactorValue'}¶
- property bio_assay_set_id¶
Gets the bio_assay_set_id of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Returns:
The bio_assay_set_id of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Return type:
int
- property factor_values_used¶
Gets the factor_values_used of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Returns:
The factor_values_used of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Return type:
dict(str, list[FactorValueValueObject])
- property factor_values_used_by_experimental_factor_id¶
Gets the factor_values_used_by_experimental_factor_id of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Returns:
The factor_values_used_by_experimental_factor_id of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Return type:
dict(str, list[FactorValueValueObject])
- property id¶
Gets the id of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Returns:
The id of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Return type:
int
- property is_subset¶
Gets the is_subset of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Returns:
The is_subset of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Return type:
bool
- property result_sets¶
Gets the result_sets of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Returns:
The result_sets of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Return type:
- property source_experiment¶
Gets the source_experiment of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Returns:
The source_experiment of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Return type:
int
- property subset_factor¶
Gets the subset_factor of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Returns:
The subset_factor of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Return type:
- property subset_factor_id¶
Gets the subset_factor_id of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Returns:
The subset_factor_id of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Return type:
int
- property subset_factor_value¶
Gets the subset_factor_value of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Returns:
The subset_factor_value of this DifferentialExpressionAnalysisValueObject. # noqa: E501
- Return type:
- swagger_types = {'array_designs_used': 'list[int]', 'bio_assay_set_id': 'int', 'factor_values_used': 'dict(str, list[FactorValueValueObject])', 'factor_values_used_by_experimental_factor_id': 'dict(str, list[FactorValueValueObject])', 'id': 'int', 'is_subset': 'bool', 'result_sets': 'list[DiffExResultSetSummaryValueObject]', 'source_experiment': 'int', 'subset_factor': 'ExperimentalFactorValueObject', 'subset_factor_id': 'int', 'subset_factor_value': 'FactorValueValueObject'}¶
- class gemmapy.sdk.models.ExperimentExpressionLevelsValueObject(dataset_id=None, gene_expression_levels=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ExperimentExpressionLevelsValueObject - a model defined in Swagger
- attribute_map = {'dataset_id': 'datasetId', 'gene_expression_levels': 'geneExpressionLevels'}¶
- property dataset_id¶
Gets the dataset_id of this ExperimentExpressionLevelsValueObject. # noqa: E501
- Returns:
The dataset_id of this ExperimentExpressionLevelsValueObject. # noqa: E501
- Return type:
int
- property gene_expression_levels¶
Gets the gene_expression_levels of this ExperimentExpressionLevelsValueObject. # noqa: E501
- Returns:
The gene_expression_levels of this ExperimentExpressionLevelsValueObject. # noqa: E501
- Return type:
- swagger_types = {'dataset_id': 'int', 'gene_expression_levels': 'list[GeneElementExpressionsValueObject]'}¶
- class gemmapy.sdk.models.ExperimentalFactorValueObject(id=None, category=None, category_uri=None, description=None, factor_values=None, name=None, type=None, values=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ExperimentalFactorValueObject - a model defined in Swagger
- attribute_map = {'category': 'category', 'category_uri': 'categoryUri', 'description': 'description', 'factor_values': 'factorValues', 'id': 'id', 'name': 'name', 'type': 'type', 'values': 'values'}¶
- property category¶
Gets the category of this ExperimentalFactorValueObject. # noqa: E501
- Returns:
The category of this ExperimentalFactorValueObject. # noqa: E501
- Return type:
str
- property category_uri¶
Gets the category_uri of this ExperimentalFactorValueObject. # noqa: E501
- Returns:
The category_uri of this ExperimentalFactorValueObject. # noqa: E501
- Return type:
str
- property description¶
Gets the description of this ExperimentalFactorValueObject. # noqa: E501
- Returns:
The description of this ExperimentalFactorValueObject. # noqa: E501
- Return type:
str
- property factor_values¶
Gets the factor_values of this ExperimentalFactorValueObject. # noqa: E501
This is deprecated, use values directly instead. # noqa: E501
- Returns:
The factor_values of this ExperimentalFactorValueObject. # noqa: E501
- Return type:
str
- property id¶
Gets the id of this ExperimentalFactorValueObject. # noqa: E501
- Returns:
The id of this ExperimentalFactorValueObject. # noqa: E501
- Return type:
int
- property name¶
Gets the name of this ExperimentalFactorValueObject. # noqa: E501
- Returns:
The name of this ExperimentalFactorValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'category': 'str', 'category_uri': 'str', 'description': 'str', 'factor_values': 'str', 'id': 'int', 'name': 'str', 'type': 'str', 'values': 'list[FactorValueValueObject]'}¶
- property type¶
Gets the type of this ExperimentalFactorValueObject. # noqa: E501
- Returns:
The type of this ExperimentalFactorValueObject. # noqa: E501
- Return type:
str
- property values¶
Gets the values of this ExperimentalFactorValueObject. # noqa: E501
- Returns:
The values of this ExperimentalFactorValueObject. # noqa: E501
- Return type:
list[FactorValueValueObject]
- class gemmapy.sdk.models.ExpressionExperimentSetValueObject(id=None, description=None, expression_experiment_ids=None, is_public=None, modifiable=None, name=None, size=None, num_with_coexpression_analysis=None, num_with_differential_expression_analysis=None, taxon_id=None, taxon_name=None, user_can_write=None, user_owned=None, is_shared=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ExpressionExperimentSetValueObject - a model defined in Swagger
- attribute_map = {'description': 'description', 'expression_experiment_ids': 'expressionExperimentIds', 'id': 'id', 'is_public': 'isPublic', 'is_shared': 'isShared', 'modifiable': 'modifiable', 'name': 'name', 'num_with_coexpression_analysis': 'numWithCoexpressionAnalysis', 'num_with_differential_expression_analysis': 'numWithDifferentialExpressionAnalysis', 'size': 'size', 'taxon_id': 'taxonId', 'taxon_name': 'taxonName', 'user_can_write': 'userCanWrite', 'user_owned': 'userOwned'}¶
- property description¶
Gets the description of this ExpressionExperimentSetValueObject. # noqa: E501
- Returns:
The description of this ExpressionExperimentSetValueObject. # noqa: E501
- Return type:
str
- property expression_experiment_ids¶
Gets the expression_experiment_ids of this ExpressionExperimentSetValueObject. # noqa: E501
- Returns:
The expression_experiment_ids of this ExpressionExperimentSetValueObject. # noqa: E501
- Return type:
list[int]
- property id¶
Gets the id of this ExpressionExperimentSetValueObject. # noqa: E501
- Returns:
The id of this ExpressionExperimentSetValueObject. # noqa: E501
- Return type:
int
- property is_public¶
Gets the is_public of this ExpressionExperimentSetValueObject. # noqa: E501
- Returns:
The is_public of this ExpressionExperimentSetValueObject. # noqa: E501
- Return type:
bool
Gets the is_shared of this ExpressionExperimentSetValueObject. # noqa: E501
- Returns:
The is_shared of this ExpressionExperimentSetValueObject. # noqa: E501
- Return type:
bool
- property modifiable¶
Gets the modifiable of this ExpressionExperimentSetValueObject. # noqa: E501
- Returns:
The modifiable of this ExpressionExperimentSetValueObject. # noqa: E501
- Return type:
bool
- property name¶
Gets the name of this ExpressionExperimentSetValueObject. # noqa: E501
- Returns:
The name of this ExpressionExperimentSetValueObject. # noqa: E501
- Return type:
str
- property num_with_coexpression_analysis¶
Gets the num_with_coexpression_analysis of this ExpressionExperimentSetValueObject. # noqa: E501
- Returns:
The num_with_coexpression_analysis of this ExpressionExperimentSetValueObject. # noqa: E501
- Return type:
int
- property num_with_differential_expression_analysis¶
Gets the num_with_differential_expression_analysis of this ExpressionExperimentSetValueObject. # noqa: E501
- Returns:
The num_with_differential_expression_analysis of this ExpressionExperimentSetValueObject. # noqa: E501
- Return type:
int
- property size¶
Gets the size of this ExpressionExperimentSetValueObject. # noqa: E501
- Returns:
The size of this ExpressionExperimentSetValueObject. # noqa: E501
- Return type:
int
- swagger_types = {'description': 'str', 'expression_experiment_ids': 'list[int]', 'id': 'int', 'is_public': 'bool', 'is_shared': 'bool', 'modifiable': 'bool', 'name': 'str', 'num_with_coexpression_analysis': 'int', 'num_with_differential_expression_analysis': 'int', 'size': 'int', 'taxon_id': 'int', 'taxon_name': 'str', 'user_can_write': 'bool', 'user_owned': 'bool'}¶
- property taxon_id¶
Gets the taxon_id of this ExpressionExperimentSetValueObject. # noqa: E501
- Returns:
The taxon_id of this ExpressionExperimentSetValueObject. # noqa: E501
- Return type:
int
- property taxon_name¶
Gets the taxon_name of this ExpressionExperimentSetValueObject. # noqa: E501
- Returns:
The taxon_name of this ExpressionExperimentSetValueObject. # noqa: E501
- Return type:
str
- property user_can_write¶
Gets the user_can_write of this ExpressionExperimentSetValueObject. # noqa: E501
- Returns:
The user_can_write of this ExpressionExperimentSetValueObject. # noqa: E501
- Return type:
bool
- property user_owned¶
Gets the user_owned of this ExpressionExperimentSetValueObject. # noqa: E501
- Returns:
The user_owned of this ExpressionExperimentSetValueObject. # noqa: E501
- Return type:
bool
- class gemmapy.sdk.models.ExpressionExperimentValueObject(id=None, last_updated=None, troubled=None, last_troubled_event=None, needs_attention=None, last_needs_attention_event=None, curation_note=None, last_note_update_event=None, number_of_bio_assays=None, description=None, name=None, accession=None, batch_confound=None, batch_effect=None, batch_effect_statistics=None, external_database=None, external_database_uri=None, external_uri=None, geeq=None, metadata=None, short_name=None, source=None, technology_type=None, taxon_id=None, bio_assay_count=None, trouble_details=None, number_of_array_designs=None, number_of_processed_expression_vectors=None, taxon=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ExpressionExperimentValueObject - a model defined in Swagger
- property accession¶
Gets the accession of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The accession of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- attribute_map = {'accession': 'accession', 'batch_confound': 'batchConfound', 'batch_effect': 'batchEffect', 'batch_effect_statistics': 'batchEffectStatistics', 'bio_assay_count': 'bioAssayCount', 'curation_note': 'curationNote', 'description': 'description', 'external_database': 'externalDatabase', 'external_database_uri': 'externalDatabaseUri', 'external_uri': 'externalUri', 'geeq': 'geeq', 'id': 'id', 'last_needs_attention_event': 'lastNeedsAttentionEvent', 'last_note_update_event': 'lastNoteUpdateEvent', 'last_troubled_event': 'lastTroubledEvent', 'last_updated': 'lastUpdated', 'metadata': 'metadata', 'name': 'name', 'needs_attention': 'needsAttention', 'number_of_array_designs': 'numberOfArrayDesigns', 'number_of_bio_assays': 'numberOfBioAssays', 'number_of_processed_expression_vectors': 'numberOfProcessedExpressionVectors', 'short_name': 'shortName', 'source': 'source', 'taxon': 'taxon', 'taxon_id': 'taxonId', 'technology_type': 'technologyType', 'trouble_details': 'troubleDetails', 'troubled': 'troubled'}¶
- property batch_confound¶
Gets the batch_confound of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The batch_confound of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- property batch_effect¶
Gets the batch_effect of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The batch_effect of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- property batch_effect_statistics¶
Gets the batch_effect_statistics of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The batch_effect_statistics of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- property bio_assay_count¶
Gets the bio_assay_count of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The bio_assay_count of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
int
- property curation_note¶
Gets the curation_note of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The curation_note of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- property description¶
Gets the description of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The description of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- property external_database¶
Gets the external_database of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The external_database of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- property external_database_uri¶
Gets the external_database_uri of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The external_database_uri of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- property external_uri¶
Gets the external_uri of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The external_uri of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- property geeq¶
Gets the geeq of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The geeq of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
- property id¶
Gets the id of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The id of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
int
- property last_needs_attention_event¶
Gets the last_needs_attention_event of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The last_needs_attention_event of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
- property last_note_update_event¶
Gets the last_note_update_event of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The last_note_update_event of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
- property last_troubled_event¶
Gets the last_troubled_event of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The last_troubled_event of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
- property last_updated¶
Gets the last_updated of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The last_updated of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
datetime
- property metadata¶
Gets the metadata of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The metadata of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- property name¶
Gets the name of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The name of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- property needs_attention¶
Gets the needs_attention of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The needs_attention of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
bool
- property number_of_array_designs¶
Gets the number_of_array_designs of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The number_of_array_designs of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
int
- property number_of_bio_assays¶
Gets the number_of_bio_assays of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The number_of_bio_assays of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
int
- property number_of_processed_expression_vectors¶
Gets the number_of_processed_expression_vectors of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The number_of_processed_expression_vectors of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
int
- property short_name¶
Gets the short_name of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The short_name of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- property source¶
Gets the source of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The source of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'accession': 'str', 'batch_confound': 'str', 'batch_effect': 'str', 'batch_effect_statistics': 'str', 'bio_assay_count': 'int', 'curation_note': 'str', 'description': 'str', 'external_database': 'str', 'external_database_uri': 'str', 'external_uri': 'str', 'geeq': 'GeeqValueObject', 'id': 'int', 'last_needs_attention_event': 'AuditEventValueObject', 'last_note_update_event': 'AuditEventValueObject', 'last_troubled_event': 'AuditEventValueObject', 'last_updated': 'datetime', 'metadata': 'str', 'name': 'str', 'needs_attention': 'bool', 'number_of_array_designs': 'int', 'number_of_bio_assays': 'int', 'number_of_processed_expression_vectors': 'int', 'short_name': 'str', 'source': 'str', 'taxon': 'TaxonValueObject', 'taxon_id': 'int', 'technology_type': 'str', 'trouble_details': 'str', 'troubled': 'bool'}¶
- property taxon¶
Gets the taxon of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The taxon of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
- property taxon_id¶
Gets the taxon_id of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The taxon_id of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
int
- property technology_type¶
Gets the technology_type of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The technology_type of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- property trouble_details¶
Gets the trouble_details of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The trouble_details of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- property troubled¶
Gets the troubled of this ExpressionExperimentValueObject. # noqa: E501
- Returns:
The troubled of this ExpressionExperimentValueObject. # noqa: E501
- Return type:
bool
- class gemmapy.sdk.models.ExpressionExperimentWithSearchResultValueObject(id=None, last_updated=None, troubled=None, last_troubled_event=None, needs_attention=None, last_needs_attention_event=None, curation_note=None, last_note_update_event=None, number_of_bio_assays=None, description=None, name=None, accession=None, batch_confound=None, batch_effect=None, batch_effect_statistics=None, external_database=None, external_database_uri=None, external_uri=None, geeq=None, metadata=None, short_name=None, source=None, technology_type=None, search_result=None, taxon_id=None, bio_assay_count=None, trouble_details=None, number_of_array_designs=None, number_of_processed_expression_vectors=None, taxon=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ExpressionExperimentWithSearchResultValueObject - a model defined in Swagger
- property accession¶
Gets the accession of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The accession of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
str
- attribute_map = {'accession': 'accession', 'batch_confound': 'batchConfound', 'batch_effect': 'batchEffect', 'batch_effect_statistics': 'batchEffectStatistics', 'bio_assay_count': 'bioAssayCount', 'curation_note': 'curationNote', 'description': 'description', 'external_database': 'externalDatabase', 'external_database_uri': 'externalDatabaseUri', 'external_uri': 'externalUri', 'geeq': 'geeq', 'id': 'id', 'last_needs_attention_event': 'lastNeedsAttentionEvent', 'last_note_update_event': 'lastNoteUpdateEvent', 'last_troubled_event': 'lastTroubledEvent', 'last_updated': 'lastUpdated', 'metadata': 'metadata', 'name': 'name', 'needs_attention': 'needsAttention', 'number_of_array_designs': 'numberOfArrayDesigns', 'number_of_bio_assays': 'numberOfBioAssays', 'number_of_processed_expression_vectors': 'numberOfProcessedExpressionVectors', 'search_result': 'searchResult', 'short_name': 'shortName', 'source': 'source', 'taxon': 'taxon', 'taxon_id': 'taxonId', 'technology_type': 'technologyType', 'trouble_details': 'troubleDetails', 'troubled': 'troubled'}¶
- property batch_confound¶
Gets the batch_confound of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The batch_confound of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
str
- property batch_effect¶
Gets the batch_effect of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The batch_effect of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
str
- property batch_effect_statistics¶
Gets the batch_effect_statistics of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The batch_effect_statistics of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
str
- property bio_assay_count¶
Gets the bio_assay_count of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The bio_assay_count of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
int
- property curation_note¶
Gets the curation_note of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The curation_note of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
str
- property description¶
Gets the description of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The description of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
str
- property external_database¶
Gets the external_database of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The external_database of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
str
- property external_database_uri¶
Gets the external_database_uri of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The external_database_uri of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
str
- property external_uri¶
Gets the external_uri of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The external_uri of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
str
- property geeq¶
Gets the geeq of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The geeq of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
- property id¶
Gets the id of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The id of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
int
- property last_needs_attention_event¶
Gets the last_needs_attention_event of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The last_needs_attention_event of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
- property last_note_update_event¶
Gets the last_note_update_event of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The last_note_update_event of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
- property last_troubled_event¶
Gets the last_troubled_event of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The last_troubled_event of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
- property last_updated¶
Gets the last_updated of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The last_updated of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
datetime
- property metadata¶
Gets the metadata of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The metadata of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
str
- property name¶
Gets the name of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The name of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
str
- property needs_attention¶
Gets the needs_attention of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The needs_attention of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
bool
- property number_of_array_designs¶
Gets the number_of_array_designs of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The number_of_array_designs of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
int
- property number_of_bio_assays¶
Gets the number_of_bio_assays of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The number_of_bio_assays of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
int
- property number_of_processed_expression_vectors¶
Gets the number_of_processed_expression_vectors of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The number_of_processed_expression_vectors of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
int
- property search_result¶
Gets the search_result of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The search_result of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
- property short_name¶
Gets the short_name of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The short_name of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
str
- property source¶
Gets the source of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The source of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'accession': 'str', 'batch_confound': 'str', 'batch_effect': 'str', 'batch_effect_statistics': 'str', 'bio_assay_count': 'int', 'curation_note': 'str', 'description': 'str', 'external_database': 'str', 'external_database_uri': 'str', 'external_uri': 'str', 'geeq': 'GeeqValueObject', 'id': 'int', 'last_needs_attention_event': 'AuditEventValueObject', 'last_note_update_event': 'AuditEventValueObject', 'last_troubled_event': 'AuditEventValueObject', 'last_updated': 'datetime', 'metadata': 'str', 'name': 'str', 'needs_attention': 'bool', 'number_of_array_designs': 'int', 'number_of_bio_assays': 'int', 'number_of_processed_expression_vectors': 'int', 'search_result': 'SearchResultValueObjectExpressionExperimentValueObject', 'short_name': 'str', 'source': 'str', 'taxon': 'TaxonValueObject', 'taxon_id': 'int', 'technology_type': 'str', 'trouble_details': 'str', 'troubled': 'bool'}¶
- property taxon¶
Gets the taxon of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The taxon of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
- property taxon_id¶
Gets the taxon_id of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The taxon_id of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
int
- property technology_type¶
Gets the technology_type of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The technology_type of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
str
- property trouble_details¶
Gets the trouble_details of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The trouble_details of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
str
- property troubled¶
Gets the troubled of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The troubled of this ExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
bool
- class gemmapy.sdk.models.ExternalDatabaseValueObject(id=None, name=None, description=None, uri=None, release_version=None, release_url=None, last_updated=None, external_databases=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ExternalDatabaseValueObject - a model defined in Swagger
- attribute_map = {'description': 'description', 'external_databases': 'externalDatabases', 'id': 'id', 'last_updated': 'lastUpdated', 'name': 'name', 'release_url': 'releaseUrl', 'release_version': 'releaseVersion', 'uri': 'uri'}¶
- property description¶
Gets the description of this ExternalDatabaseValueObject. # noqa: E501
- Returns:
The description of this ExternalDatabaseValueObject. # noqa: E501
- Return type:
str
- property external_databases¶
Gets the external_databases of this ExternalDatabaseValueObject. # noqa: E501
- Returns:
The external_databases of this ExternalDatabaseValueObject. # noqa: E501
- Return type:
- property id¶
Gets the id of this ExternalDatabaseValueObject. # noqa: E501
- Returns:
The id of this ExternalDatabaseValueObject. # noqa: E501
- Return type:
int
- property last_updated¶
Gets the last_updated of this ExternalDatabaseValueObject. # noqa: E501
- Returns:
The last_updated of this ExternalDatabaseValueObject. # noqa: E501
- Return type:
datetime
- property name¶
Gets the name of this ExternalDatabaseValueObject. # noqa: E501
- Returns:
The name of this ExternalDatabaseValueObject. # noqa: E501
- Return type:
str
- property release_url¶
Gets the release_url of this ExternalDatabaseValueObject. # noqa: E501
- Returns:
The release_url of this ExternalDatabaseValueObject. # noqa: E501
- Return type:
str
- property release_version¶
Gets the release_version of this ExternalDatabaseValueObject. # noqa: E501
- Returns:
The release_version of this ExternalDatabaseValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'description': 'str', 'external_databases': 'list[ExternalDatabaseValueObject]', 'id': 'int', 'last_updated': 'datetime', 'name': 'str', 'release_url': 'str', 'release_version': 'str', 'uri': 'str'}¶
- property uri¶
Gets the uri of this ExternalDatabaseValueObject. # noqa: E501
- Returns:
The uri of this ExternalDatabaseValueObject. # noqa: E501
- Return type:
str
- class gemmapy.sdk.models.FactorValueBasicValueObject(id=None, ontology_id=None, experimental_factor_id=None, experimental_factor_category=None, measurement=None, characteristics=None, statements=None, value=None, summary=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
FactorValueBasicValueObject - a model defined in Swagger
- attribute_map = {'characteristics': 'characteristics', 'experimental_factor_category': 'experimentalFactorCategory', 'experimental_factor_id': 'experimentalFactorId', 'id': 'id', 'measurement': 'measurement', 'ontology_id': 'ontologyId', 'statements': 'statements', 'summary': 'summary', 'value': 'value'}¶
- property characteristics¶
Gets the characteristics of this FactorValueBasicValueObject. # noqa: E501
- Returns:
The characteristics of this FactorValueBasicValueObject. # noqa: E501
- Return type:
- property experimental_factor_category¶
Gets the experimental_factor_category of this FactorValueBasicValueObject. # noqa: E501
- Returns:
The experimental_factor_category of this FactorValueBasicValueObject. # noqa: E501
- Return type:
- property experimental_factor_id¶
Gets the experimental_factor_id of this FactorValueBasicValueObject. # noqa: E501
- Returns:
The experimental_factor_id of this FactorValueBasicValueObject. # noqa: E501
- Return type:
int
- property id¶
Gets the id of this FactorValueBasicValueObject. # noqa: E501
- Returns:
The id of this FactorValueBasicValueObject. # noqa: E501
- Return type:
int
- property measurement¶
Gets the measurement of this FactorValueBasicValueObject. # noqa: E501
- Returns:
The measurement of this FactorValueBasicValueObject. # noqa: E501
- Return type:
- property ontology_id¶
Gets the ontology_id of this FactorValueBasicValueObject. # noqa: E501
- Returns:
The ontology_id of this FactorValueBasicValueObject. # noqa: E501
- Return type:
str
- property statements¶
Gets the statements of this FactorValueBasicValueObject. # noqa: E501
- Returns:
The statements of this FactorValueBasicValueObject. # noqa: E501
- Return type:
list[StatementValueObject]
- property summary¶
Gets the summary of this FactorValueBasicValueObject. # noqa: E501
- Returns:
The summary of this FactorValueBasicValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'characteristics': 'list[CharacteristicValueObject]', 'experimental_factor_category': 'CharacteristicValueObject', 'experimental_factor_id': 'int', 'id': 'int', 'measurement': 'MeasurementValueObject', 'ontology_id': 'str', 'statements': 'list[StatementValueObject]', 'summary': 'str', 'value': 'str'}¶
- property value¶
Gets the value of this FactorValueBasicValueObject. # noqa: E501
Use summary if you need a human-readable representation of this factor value or lookup the characteristics bag. # noqa: E501
- Returns:
The value of this FactorValueBasicValueObject. # noqa: E501
- Return type:
str
- class gemmapy.sdk.models.FactorValueValueObject(id=None, ontology_id=None, experimental_factor_id=None, experimental_factor_category=None, characteristics=None, statements=None, summary=None, factor_id=None, char_id=None, category=None, category_uri=None, description=None, factor_value=None, measurement=None, is_measurement=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
FactorValueValueObject - a model defined in Swagger
- attribute_map = {'category': 'category', 'category_uri': 'categoryUri', 'char_id': 'charId', 'characteristics': 'characteristics', 'description': 'description', 'experimental_factor_category': 'experimentalFactorCategory', 'experimental_factor_id': 'experimentalFactorId', 'factor_id': 'factorId', 'factor_value': 'factorValue', 'id': 'id', 'is_measurement': 'isMeasurement', 'measurement': 'measurement', 'ontology_id': 'ontologyId', 'statements': 'statements', 'summary': 'summary'}¶
- property category¶
Gets the category of this FactorValueValueObject. # noqa: E501
Use experimentalFactorCategory.category instead. # noqa: E501
- Returns:
The category of this FactorValueValueObject. # noqa: E501
- Return type:
str
- property category_uri¶
Gets the category_uri of this FactorValueValueObject. # noqa: E501
Use experimentalFactorCategory.categoryUri instead. # noqa: E501
- Returns:
The category_uri of this FactorValueValueObject. # noqa: E501
- Return type:
str
- property char_id¶
Gets the char_id of this FactorValueValueObject. # noqa: E501
Use measurement.id or characteristics.id instead. # noqa: E501
- Returns:
The char_id of this FactorValueValueObject. # noqa: E501
- Return type:
int
- property characteristics¶
Gets the characteristics of this FactorValueValueObject. # noqa: E501
- Returns:
The characteristics of this FactorValueValueObject. # noqa: E501
- Return type:
- property description¶
Gets the description of this FactorValueValueObject. # noqa: E501
This property is never filled nor used; use summary if you need a human-readable representation of this factor value. # noqa: E501
- Returns:
The description of this FactorValueValueObject. # noqa: E501
- Return type:
str
- property experimental_factor_category¶
Gets the experimental_factor_category of this FactorValueValueObject. # noqa: E501
- Returns:
The experimental_factor_category of this FactorValueValueObject. # noqa: E501
- Return type:
- property experimental_factor_id¶
Gets the experimental_factor_id of this FactorValueValueObject. # noqa: E501
- Returns:
The experimental_factor_id of this FactorValueValueObject. # noqa: E501
- Return type:
int
- property factor_id¶
Gets the factor_id of this FactorValueValueObject. # noqa: E501
Use experimentalFactorId instead. # noqa: E501
- Returns:
The factor_id of this FactorValueValueObject. # noqa: E501
- Return type:
int
- property factor_value¶
Gets the factor_value of this FactorValueValueObject. # noqa: E501
Use summary if you need a human-readable representation of this factor value or lookup the characteristics bag. # noqa: E501
- Returns:
The factor_value of this FactorValueValueObject. # noqa: E501
- Return type:
str
- property id¶
Gets the id of this FactorValueValueObject. # noqa: E501
- Returns:
The id of this FactorValueValueObject. # noqa: E501
- Return type:
int
- property is_measurement¶
Gets the is_measurement of this FactorValueValueObject. # noqa: E501
Check if a measurement key exists instead. # noqa: E501
- Returns:
The is_measurement of this FactorValueValueObject. # noqa: E501
- Return type:
bool
- property measurement¶
Gets the measurement of this FactorValueValueObject. # noqa: E501
- Returns:
The measurement of this FactorValueValueObject. # noqa: E501
- Return type:
- property ontology_id¶
Gets the ontology_id of this FactorValueValueObject. # noqa: E501
- Returns:
The ontology_id of this FactorValueValueObject. # noqa: E501
- Return type:
str
- property statements¶
Gets the statements of this FactorValueValueObject. # noqa: E501
- Returns:
The statements of this FactorValueValueObject. # noqa: E501
- Return type:
list[StatementValueObject]
- property summary¶
Gets the summary of this FactorValueValueObject. # noqa: E501
- Returns:
The summary of this FactorValueValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'category': 'str', 'category_uri': 'str', 'char_id': 'int', 'characteristics': 'list[CharacteristicValueObject]', 'description': 'str', 'experimental_factor_category': 'CharacteristicValueObject', 'experimental_factor_id': 'int', 'factor_id': 'int', 'factor_value': 'str', 'id': 'int', 'is_measurement': 'bool', 'measurement': 'MeasurementValueObject', 'ontology_id': 'str', 'statements': 'list[StatementValueObject]', 'summary': 'str'}¶
- class gemmapy.sdk.models.FilterArgArrayDesign[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
FilterArgArrayDesign - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.FilterArgExpressionAnalysisResultSet[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
FilterArgExpressionAnalysisResultSet - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.FilterArgExpressionExperiment[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
FilterArgExpressionExperiment - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.FilteredAndPaginatedResponseDataObjectArrayDesignValueObject(data=None, filter=None, group_by=None, sort=None, offset=None, limit=None, total_elements=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
FilteredAndPaginatedResponseDataObjectArrayDesignValueObject - a model defined in Swagger
- attribute_map = {'data': 'data', 'filter': 'filter', 'group_by': 'groupBy', 'limit': 'limit', 'offset': 'offset', 'sort': 'sort', 'total_elements': 'totalElements'}¶
- property data¶
Gets the data of this FilteredAndPaginatedResponseDataObjectArrayDesignValueObject. # noqa: E501
- Returns:
The data of this FilteredAndPaginatedResponseDataObjectArrayDesignValueObject. # noqa: E501
- Return type:
list[ArrayDesignValueObject]
- property filter¶
Gets the filter of this FilteredAndPaginatedResponseDataObjectArrayDesignValueObject. # noqa: E501
- Returns:
The filter of this FilteredAndPaginatedResponseDataObjectArrayDesignValueObject. # noqa: E501
- Return type:
str
- property group_by¶
Gets the group_by of this FilteredAndPaginatedResponseDataObjectArrayDesignValueObject. # noqa: E501
- Returns:
The group_by of this FilteredAndPaginatedResponseDataObjectArrayDesignValueObject. # noqa: E501
- Return type:
list[str]
- property limit¶
Gets the limit of this FilteredAndPaginatedResponseDataObjectArrayDesignValueObject. # noqa: E501
- Returns:
The limit of this FilteredAndPaginatedResponseDataObjectArrayDesignValueObject. # noqa: E501
- Return type:
int
- property offset¶
Gets the offset of this FilteredAndPaginatedResponseDataObjectArrayDesignValueObject. # noqa: E501
- Returns:
The offset of this FilteredAndPaginatedResponseDataObjectArrayDesignValueObject. # noqa: E501
- Return type:
int
- property sort¶
Gets the sort of this FilteredAndPaginatedResponseDataObjectArrayDesignValueObject. # noqa: E501
- Returns:
The sort of this FilteredAndPaginatedResponseDataObjectArrayDesignValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[ArrayDesignValueObject]', 'filter': 'str', 'group_by': 'list[str]', 'limit': 'int', 'offset': 'int', 'sort': 'SortValueObject', 'total_elements': 'int'}¶
- property total_elements¶
Gets the total_elements of this FilteredAndPaginatedResponseDataObjectArrayDesignValueObject. # noqa: E501
- Returns:
The total_elements of this FilteredAndPaginatedResponseDataObjectArrayDesignValueObject. # noqa: E501
- Return type:
int
- class gemmapy.sdk.models.FilteredAndPaginatedResponseDataObjectCompositeSequenceValueObject(data=None, filter=None, group_by=None, sort=None, offset=None, limit=None, total_elements=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
FilteredAndPaginatedResponseDataObjectCompositeSequenceValueObject - a model defined in Swagger
- attribute_map = {'data': 'data', 'filter': 'filter', 'group_by': 'groupBy', 'limit': 'limit', 'offset': 'offset', 'sort': 'sort', 'total_elements': 'totalElements'}¶
- property data¶
Gets the data of this FilteredAndPaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Returns:
The data of this FilteredAndPaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Return type:
- property filter¶
Gets the filter of this FilteredAndPaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Returns:
The filter of this FilteredAndPaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Return type:
str
- property group_by¶
Gets the group_by of this FilteredAndPaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Returns:
The group_by of this FilteredAndPaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Return type:
list[str]
- property limit¶
Gets the limit of this FilteredAndPaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Returns:
The limit of this FilteredAndPaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Return type:
int
- property offset¶
Gets the offset of this FilteredAndPaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Returns:
The offset of this FilteredAndPaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Return type:
int
- property sort¶
Gets the sort of this FilteredAndPaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Returns:
The sort of this FilteredAndPaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[CompositeSequenceValueObject]', 'filter': 'str', 'group_by': 'list[str]', 'limit': 'int', 'offset': 'int', 'sort': 'SortValueObject', 'total_elements': 'int'}¶
- property total_elements¶
Gets the total_elements of this FilteredAndPaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Returns:
The total_elements of this FilteredAndPaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Return type:
int
- class gemmapy.sdk.models.FilteredAndPaginatedResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject(data=None, filter=None, group_by=None, sort=None, offset=None, limit=None, total_elements=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
FilteredAndPaginatedResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject - a model defined in Swagger
- attribute_map = {'data': 'data', 'filter': 'filter', 'group_by': 'groupBy', 'limit': 'limit', 'offset': 'offset', 'sort': 'sort', 'total_elements': 'totalElements'}¶
- property data¶
Gets the data of this FilteredAndPaginatedResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Returns:
The data of this FilteredAndPaginatedResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Return type:
- property filter¶
Gets the filter of this FilteredAndPaginatedResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Returns:
The filter of this FilteredAndPaginatedResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Return type:
str
- property group_by¶
Gets the group_by of this FilteredAndPaginatedResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Returns:
The group_by of this FilteredAndPaginatedResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Return type:
list[str]
- property limit¶
Gets the limit of this FilteredAndPaginatedResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Returns:
The limit of this FilteredAndPaginatedResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Return type:
int
- property offset¶
Gets the offset of this FilteredAndPaginatedResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Returns:
The offset of this FilteredAndPaginatedResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Return type:
int
- property sort¶
Gets the sort of this FilteredAndPaginatedResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Returns:
The sort of this FilteredAndPaginatedResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[DifferentialExpressionAnalysisResultSetValueObject]', 'filter': 'str', 'group_by': 'list[str]', 'limit': 'int', 'offset': 'int', 'sort': 'SortValueObject', 'total_elements': 'int'}¶
- property total_elements¶
Gets the total_elements of this FilteredAndPaginatedResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Returns:
The total_elements of this FilteredAndPaginatedResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Return type:
int
- class gemmapy.sdk.models.FilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject(data=None, filter=None, group_by=None, sort=None, offset=None, limit=None, total_elements=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
FilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject - a model defined in Swagger
- attribute_map = {'data': 'data', 'filter': 'filter', 'group_by': 'groupBy', 'limit': 'limit', 'offset': 'offset', 'sort': 'sort', 'total_elements': 'totalElements'}¶
- property data¶
Gets the data of this FilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The data of this FilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
- property filter¶
Gets the filter of this FilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The filter of this FilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- property group_by¶
Gets the group_by of this FilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The group_by of this FilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
list[str]
- property limit¶
Gets the limit of this FilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The limit of this FilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
int
- property offset¶
Gets the offset of this FilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The offset of this FilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
int
- property sort¶
Gets the sort of this FilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The sort of this FilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[ExpressionExperimentValueObject]', 'filter': 'str', 'group_by': 'list[str]', 'limit': 'int', 'offset': 'int', 'sort': 'SortValueObject', 'total_elements': 'int'}¶
- property total_elements¶
Gets the total_elements of this FilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The total_elements of this FilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
int
- class gemmapy.sdk.models.FilteredAndPaginatedResponseDataObjectGeneValueObject(data=None, filter=None, group_by=None, sort=None, offset=None, limit=None, total_elements=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
FilteredAndPaginatedResponseDataObjectGeneValueObject - a model defined in Swagger
- attribute_map = {'data': 'data', 'filter': 'filter', 'group_by': 'groupBy', 'limit': 'limit', 'offset': 'offset', 'sort': 'sort', 'total_elements': 'totalElements'}¶
- property data¶
Gets the data of this FilteredAndPaginatedResponseDataObjectGeneValueObject. # noqa: E501
- Returns:
The data of this FilteredAndPaginatedResponseDataObjectGeneValueObject. # noqa: E501
- Return type:
list[GeneValueObject]
- property filter¶
Gets the filter of this FilteredAndPaginatedResponseDataObjectGeneValueObject. # noqa: E501
- Returns:
The filter of this FilteredAndPaginatedResponseDataObjectGeneValueObject. # noqa: E501
- Return type:
str
- property group_by¶
Gets the group_by of this FilteredAndPaginatedResponseDataObjectGeneValueObject. # noqa: E501
- Returns:
The group_by of this FilteredAndPaginatedResponseDataObjectGeneValueObject. # noqa: E501
- Return type:
list[str]
- property limit¶
Gets the limit of this FilteredAndPaginatedResponseDataObjectGeneValueObject. # noqa: E501
- Returns:
The limit of this FilteredAndPaginatedResponseDataObjectGeneValueObject. # noqa: E501
- Return type:
int
- property offset¶
Gets the offset of this FilteredAndPaginatedResponseDataObjectGeneValueObject. # noqa: E501
- Returns:
The offset of this FilteredAndPaginatedResponseDataObjectGeneValueObject. # noqa: E501
- Return type:
int
- property sort¶
Gets the sort of this FilteredAndPaginatedResponseDataObjectGeneValueObject. # noqa: E501
- Returns:
The sort of this FilteredAndPaginatedResponseDataObjectGeneValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[GeneValueObject]', 'filter': 'str', 'group_by': 'list[str]', 'limit': 'int', 'offset': 'int', 'sort': 'SortValueObject', 'total_elements': 'int'}¶
- property total_elements¶
Gets the total_elements of this FilteredAndPaginatedResponseDataObjectGeneValueObject. # noqa: E501
- Returns:
The total_elements of this FilteredAndPaginatedResponseDataObjectGeneValueObject. # noqa: E501
- Return type:
int
- class gemmapy.sdk.models.GeeqValueObject(id=None, public_quality_score=None, public_suitability_score=None, no_vectors=None, corr_mat_issues=None, replicates_issues=None, batch_corrected=None, s_score_publication=None, s_score_platform_amount=None, s_score_platform_tech_multi=None, s_score_avg_platform_popularity=None, s_score_avg_platform_size=None, s_score_sample_size=None, s_score_raw_data=None, s_score_missing_values=None, q_score_outliers=None, q_score_sample_mean_correlation=None, q_score_sample_median_correlation=None, q_score_sample_correlation_variance=None, q_score_platforms_tech=None, q_score_replicates=None, q_score_batch_info=None, q_score_public_batch_effect=None, q_score_public_batch_confound=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
GeeqValueObject - a model defined in Swagger
- attribute_map = {'batch_corrected': 'batchCorrected', 'corr_mat_issues': 'corrMatIssues', 'id': 'id', 'no_vectors': 'noVectors', 'public_quality_score': 'publicQualityScore', 'public_suitability_score': 'publicSuitabilityScore', 'q_score_batch_info': 'qScoreBatchInfo', 'q_score_outliers': 'qScoreOutliers', 'q_score_platforms_tech': 'qScorePlatformsTech', 'q_score_public_batch_confound': 'qScorePublicBatchConfound', 'q_score_public_batch_effect': 'qScorePublicBatchEffect', 'q_score_replicates': 'qScoreReplicates', 'q_score_sample_correlation_variance': 'qScoreSampleCorrelationVariance', 'q_score_sample_mean_correlation': 'qScoreSampleMeanCorrelation', 'q_score_sample_median_correlation': 'qScoreSampleMedianCorrelation', 'replicates_issues': 'replicatesIssues', 's_score_avg_platform_popularity': 'sScoreAvgPlatformPopularity', 's_score_avg_platform_size': 'sScoreAvgPlatformSize', 's_score_missing_values': 'sScoreMissingValues', 's_score_platform_amount': 'sScorePlatformAmount', 's_score_platform_tech_multi': 'sScorePlatformTechMulti', 's_score_publication': 'sScorePublication', 's_score_raw_data': 'sScoreRawData', 's_score_sample_size': 'sScoreSampleSize'}¶
- property batch_corrected¶
Gets the batch_corrected of this GeeqValueObject. # noqa: E501
- Returns:
The batch_corrected of this GeeqValueObject. # noqa: E501
- Return type:
bool
- property corr_mat_issues¶
Gets the corr_mat_issues of this GeeqValueObject. # noqa: E501
- Returns:
The corr_mat_issues of this GeeqValueObject. # noqa: E501
- Return type:
str
- property id¶
Gets the id of this GeeqValueObject. # noqa: E501
- Returns:
The id of this GeeqValueObject. # noqa: E501
- Return type:
int
- property no_vectors¶
Gets the no_vectors of this GeeqValueObject. # noqa: E501
- Returns:
The no_vectors of this GeeqValueObject. # noqa: E501
- Return type:
bool
- property public_quality_score¶
Gets the public_quality_score of this GeeqValueObject. # noqa: E501
- Returns:
The public_quality_score of this GeeqValueObject. # noqa: E501
- Return type:
float
- property public_suitability_score¶
Gets the public_suitability_score of this GeeqValueObject. # noqa: E501
- Returns:
The public_suitability_score of this GeeqValueObject. # noqa: E501
- Return type:
float
- property q_score_batch_info¶
Gets the q_score_batch_info of this GeeqValueObject. # noqa: E501
- Returns:
The q_score_batch_info of this GeeqValueObject. # noqa: E501
- Return type:
float
- property q_score_outliers¶
Gets the q_score_outliers of this GeeqValueObject. # noqa: E501
- Returns:
The q_score_outliers of this GeeqValueObject. # noqa: E501
- Return type:
float
- property q_score_platforms_tech¶
Gets the q_score_platforms_tech of this GeeqValueObject. # noqa: E501
- Returns:
The q_score_platforms_tech of this GeeqValueObject. # noqa: E501
- Return type:
float
- property q_score_public_batch_confound¶
Gets the q_score_public_batch_confound of this GeeqValueObject. # noqa: E501
- Returns:
The q_score_public_batch_confound of this GeeqValueObject. # noqa: E501
- Return type:
float
- property q_score_public_batch_effect¶
Gets the q_score_public_batch_effect of this GeeqValueObject. # noqa: E501
- Returns:
The q_score_public_batch_effect of this GeeqValueObject. # noqa: E501
- Return type:
float
- property q_score_replicates¶
Gets the q_score_replicates of this GeeqValueObject. # noqa: E501
- Returns:
The q_score_replicates of this GeeqValueObject. # noqa: E501
- Return type:
float
- property q_score_sample_correlation_variance¶
Gets the q_score_sample_correlation_variance of this GeeqValueObject. # noqa: E501
- Returns:
The q_score_sample_correlation_variance of this GeeqValueObject. # noqa: E501
- Return type:
float
- property q_score_sample_mean_correlation¶
Gets the q_score_sample_mean_correlation of this GeeqValueObject. # noqa: E501
- Returns:
The q_score_sample_mean_correlation of this GeeqValueObject. # noqa: E501
- Return type:
float
- property q_score_sample_median_correlation¶
Gets the q_score_sample_median_correlation of this GeeqValueObject. # noqa: E501
- Returns:
The q_score_sample_median_correlation of this GeeqValueObject. # noqa: E501
- Return type:
float
- property replicates_issues¶
Gets the replicates_issues of this GeeqValueObject. # noqa: E501
- Returns:
The replicates_issues of this GeeqValueObject. # noqa: E501
- Return type:
str
- property s_score_avg_platform_popularity¶
Gets the s_score_avg_platform_popularity of this GeeqValueObject. # noqa: E501
- Returns:
The s_score_avg_platform_popularity of this GeeqValueObject. # noqa: E501
- Return type:
float
- property s_score_avg_platform_size¶
Gets the s_score_avg_platform_size of this GeeqValueObject. # noqa: E501
- Returns:
The s_score_avg_platform_size of this GeeqValueObject. # noqa: E501
- Return type:
float
- property s_score_missing_values¶
Gets the s_score_missing_values of this GeeqValueObject. # noqa: E501
- Returns:
The s_score_missing_values of this GeeqValueObject. # noqa: E501
- Return type:
float
- property s_score_platform_amount¶
Gets the s_score_platform_amount of this GeeqValueObject. # noqa: E501
- Returns:
The s_score_platform_amount of this GeeqValueObject. # noqa: E501
- Return type:
float
- property s_score_platform_tech_multi¶
Gets the s_score_platform_tech_multi of this GeeqValueObject. # noqa: E501
- Returns:
The s_score_platform_tech_multi of this GeeqValueObject. # noqa: E501
- Return type:
float
- property s_score_publication¶
Gets the s_score_publication of this GeeqValueObject. # noqa: E501
- Returns:
The s_score_publication of this GeeqValueObject. # noqa: E501
- Return type:
float
- property s_score_raw_data¶
Gets the s_score_raw_data of this GeeqValueObject. # noqa: E501
- Returns:
The s_score_raw_data of this GeeqValueObject. # noqa: E501
- Return type:
float
- property s_score_sample_size¶
Gets the s_score_sample_size of this GeeqValueObject. # noqa: E501
- Returns:
The s_score_sample_size of this GeeqValueObject. # noqa: E501
- Return type:
float
- swagger_types = {'batch_corrected': 'bool', 'corr_mat_issues': 'str', 'id': 'int', 'no_vectors': 'bool', 'public_quality_score': 'float', 'public_suitability_score': 'float', 'q_score_batch_info': 'float', 'q_score_outliers': 'float', 'q_score_platforms_tech': 'float', 'q_score_public_batch_confound': 'float', 'q_score_public_batch_effect': 'float', 'q_score_replicates': 'float', 'q_score_sample_correlation_variance': 'float', 'q_score_sample_mean_correlation': 'float', 'q_score_sample_median_correlation': 'float', 'replicates_issues': 'str', 's_score_avg_platform_popularity': 'float', 's_score_avg_platform_size': 'float', 's_score_missing_values': 'float', 's_score_platform_amount': 'float', 's_score_platform_tech_multi': 'float', 's_score_publication': 'float', 's_score_raw_data': 'float', 's_score_sample_size': 'float'}¶
- class gemmapy.sdk.models.Gene[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Gene - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Gene1[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Gene1 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Gene2[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Gene2 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Gene3[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Gene3 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Gene4[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Gene4 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.GeneArg[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
GeneArg - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.GeneElementExpressionsValueObject(gene_official_symbol=None, gene_ncbi_id=None, vectors=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
GeneElementExpressionsValueObject - a model defined in Swagger
- attribute_map = {'gene_ncbi_id': 'geneNcbiId', 'gene_official_symbol': 'geneOfficialSymbol', 'vectors': 'vectors'}¶
- property gene_ncbi_id¶
Gets the gene_ncbi_id of this GeneElementExpressionsValueObject. # noqa: E501
- Returns:
The gene_ncbi_id of this GeneElementExpressionsValueObject. # noqa: E501
- Return type:
int
- property gene_official_symbol¶
Gets the gene_official_symbol of this GeneElementExpressionsValueObject. # noqa: E501
- Returns:
The gene_official_symbol of this GeneElementExpressionsValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'gene_ncbi_id': 'int', 'gene_official_symbol': 'str', 'vectors': 'list[VectorElementValueObject]'}¶
- property vectors¶
Gets the vectors of this GeneElementExpressionsValueObject. # noqa: E501
- Returns:
The vectors of this GeneElementExpressionsValueObject. # noqa: E501
- Return type:
list[VectorElementValueObject]
- class gemmapy.sdk.models.GeneOntologyTermValueObject(go_id=None, label=None, uri=None, comment=None, local_name=None, term=None, obsolete=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
GeneOntologyTermValueObject - a model defined in Swagger
- attribute_map = {'comment': 'comment', 'go_id': 'goId', 'label': 'label', 'local_name': 'localName', 'obsolete': 'obsolete', 'term': 'term', 'uri': 'uri'}¶
- property comment¶
Gets the comment of this GeneOntologyTermValueObject. # noqa: E501
- Returns:
The comment of this GeneOntologyTermValueObject. # noqa: E501
- Return type:
str
- property go_id¶
Gets the go_id of this GeneOntologyTermValueObject. # noqa: E501
- Returns:
The go_id of this GeneOntologyTermValueObject. # noqa: E501
- Return type:
str
- property label¶
Gets the label of this GeneOntologyTermValueObject. # noqa: E501
- Returns:
The label of this GeneOntologyTermValueObject. # noqa: E501
- Return type:
str
- property local_name¶
Gets the local_name of this GeneOntologyTermValueObject. # noqa: E501
- Returns:
The local_name of this GeneOntologyTermValueObject. # noqa: E501
- Return type:
str
- property obsolete¶
Gets the obsolete of this GeneOntologyTermValueObject. # noqa: E501
- Returns:
The obsolete of this GeneOntologyTermValueObject. # noqa: E501
- Return type:
bool
- swagger_types = {'comment': 'str', 'go_id': 'str', 'label': 'str', 'local_name': 'str', 'obsolete': 'bool', 'term': 'str', 'uri': 'str'}¶
- property term¶
Gets the term of this GeneOntologyTermValueObject. # noqa: E501
- Returns:
The term of this GeneOntologyTermValueObject. # noqa: E501
- Return type:
str
- property uri¶
Gets the uri of this GeneOntologyTermValueObject. # noqa: E501
- Returns:
The uri of this GeneOntologyTermValueObject. # noqa: E501
- Return type:
str
- class gemmapy.sdk.models.GeneSetValueObject(id=None, name=None, description=None, gene_ids=None, size=None, taxon=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
GeneSetValueObject - a model defined in Swagger
- attribute_map = {'description': 'description', 'gene_ids': 'geneIds', 'id': 'id', 'name': 'name', 'size': 'size', 'taxon': 'taxon'}¶
- property description¶
Gets the description of this GeneSetValueObject. # noqa: E501
- Returns:
The description of this GeneSetValueObject. # noqa: E501
- Return type:
str
- property gene_ids¶
Gets the gene_ids of this GeneSetValueObject. # noqa: E501
- Returns:
The gene_ids of this GeneSetValueObject. # noqa: E501
- Return type:
list[int]
- property id¶
Gets the id of this GeneSetValueObject. # noqa: E501
- Returns:
The id of this GeneSetValueObject. # noqa: E501
- Return type:
int
- property name¶
Gets the name of this GeneSetValueObject. # noqa: E501
- Returns:
The name of this GeneSetValueObject. # noqa: E501
- Return type:
str
- property size¶
Gets the size of this GeneSetValueObject. # noqa: E501
- Returns:
The size of this GeneSetValueObject. # noqa: E501
- Return type:
int
- swagger_types = {'description': 'str', 'gene_ids': 'list[int]', 'id': 'int', 'name': 'str', 'size': 'int', 'taxon': 'TaxonValueObject'}¶
- property taxon¶
Gets the taxon of this GeneSetValueObject. # noqa: E501
- Returns:
The taxon of this GeneSetValueObject. # noqa: E501
- Return type:
- class gemmapy.sdk.models.GeneValueObject(id=None, aliases=None, multifunctionality_rank=None, ncbi_id=None, ensembl_id=None, accessions=None, official_name=None, official_symbol=None, taxon=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
GeneValueObject - a model defined in Swagger
- property accessions¶
Gets the accessions of this GeneValueObject. # noqa: E501
- Returns:
The accessions of this GeneValueObject. # noqa: E501
- Return type:
list[DatabaseEntryValueObject]
- property aliases¶
Gets the aliases of this GeneValueObject. # noqa: E501
- Returns:
The aliases of this GeneValueObject. # noqa: E501
- Return type:
list[str]
- attribute_map = {'accessions': 'accessions', 'aliases': 'aliases', 'ensembl_id': 'ensemblId', 'id': 'id', 'multifunctionality_rank': 'multifunctionalityRank', 'ncbi_id': 'ncbiId', 'official_name': 'officialName', 'official_symbol': 'officialSymbol', 'taxon': 'taxon'}¶
- property ensembl_id¶
Gets the ensembl_id of this GeneValueObject. # noqa: E501
- Returns:
The ensembl_id of this GeneValueObject. # noqa: E501
- Return type:
str
- property id¶
Gets the id of this GeneValueObject. # noqa: E501
- Returns:
The id of this GeneValueObject. # noqa: E501
- Return type:
int
- property multifunctionality_rank¶
Gets the multifunctionality_rank of this GeneValueObject. # noqa: E501
- Returns:
The multifunctionality_rank of this GeneValueObject. # noqa: E501
- Return type:
float
- property ncbi_id¶
Gets the ncbi_id of this GeneValueObject. # noqa: E501
- Returns:
The ncbi_id of this GeneValueObject. # noqa: E501
- Return type:
int
- property official_name¶
Gets the official_name of this GeneValueObject. # noqa: E501
- Returns:
The official_name of this GeneValueObject. # noqa: E501
- Return type:
str
- property official_symbol¶
Gets the official_symbol of this GeneValueObject. # noqa: E501
- Returns:
The official_symbol of this GeneValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'accessions': 'list[DatabaseEntryValueObject]', 'aliases': 'list[str]', 'ensembl_id': 'str', 'id': 'int', 'multifunctionality_rank': 'float', 'ncbi_id': 'int', 'official_name': 'str', 'official_symbol': 'str', 'taxon': 'TaxonValueObject'}¶
- property taxon¶
Gets the taxon of this GeneValueObject. # noqa: E501
- Returns:
The taxon of this GeneValueObject. # noqa: E501
- Return type:
- class gemmapy.sdk.models.LimitedResponseDataObjectAnnotationWithUsageStatisticsValueObject(data=None, query=None, filter=None, group_by=None, sort=None, limit=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
LimitedResponseDataObjectAnnotationWithUsageStatisticsValueObject - a model defined in Swagger
- attribute_map = {'data': 'data', 'filter': 'filter', 'group_by': 'groupBy', 'limit': 'limit', 'query': 'query', 'sort': 'sort'}¶
- property data¶
Gets the data of this LimitedResponseDataObjectAnnotationWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The data of this LimitedResponseDataObjectAnnotationWithUsageStatisticsValueObject. # noqa: E501
- Return type:
- property filter¶
Gets the filter of this LimitedResponseDataObjectAnnotationWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The filter of this LimitedResponseDataObjectAnnotationWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property group_by¶
Gets the group_by of this LimitedResponseDataObjectAnnotationWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The group_by of this LimitedResponseDataObjectAnnotationWithUsageStatisticsValueObject. # noqa: E501
- Return type:
list[str]
- property limit¶
Gets the limit of this LimitedResponseDataObjectAnnotationWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The limit of this LimitedResponseDataObjectAnnotationWithUsageStatisticsValueObject. # noqa: E501
- Return type:
int
- property query¶
Gets the query of this LimitedResponseDataObjectAnnotationWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The query of this LimitedResponseDataObjectAnnotationWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property sort¶
Gets the sort of this LimitedResponseDataObjectAnnotationWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The sort of this LimitedResponseDataObjectAnnotationWithUsageStatisticsValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[AnnotationWithUsageStatisticsValueObject]', 'filter': 'str', 'group_by': 'list[str]', 'limit': 'int', 'query': 'str', 'sort': 'SortValueObject'}¶
- class gemmapy.sdk.models.LimitedResponseDataObjectArrayDesignWithUsageStatisticsValueObject(data=None, query=None, filter=None, group_by=None, sort=None, limit=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
LimitedResponseDataObjectArrayDesignWithUsageStatisticsValueObject - a model defined in Swagger
- attribute_map = {'data': 'data', 'filter': 'filter', 'group_by': 'groupBy', 'limit': 'limit', 'query': 'query', 'sort': 'sort'}¶
- property data¶
Gets the data of this LimitedResponseDataObjectArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The data of this LimitedResponseDataObjectArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
- property filter¶
Gets the filter of this LimitedResponseDataObjectArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The filter of this LimitedResponseDataObjectArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property group_by¶
Gets the group_by of this LimitedResponseDataObjectArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The group_by of this LimitedResponseDataObjectArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
list[str]
- property limit¶
Gets the limit of this LimitedResponseDataObjectArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The limit of this LimitedResponseDataObjectArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
int
- property query¶
Gets the query of this LimitedResponseDataObjectArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The query of this LimitedResponseDataObjectArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property sort¶
Gets the sort of this LimitedResponseDataObjectArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The sort of this LimitedResponseDataObjectArrayDesignWithUsageStatisticsValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[ArrayDesignWithUsageStatisticsValueObject]', 'filter': 'str', 'group_by': 'list[str]', 'limit': 'int', 'query': 'str', 'sort': 'SortValueObject'}¶
- class gemmapy.sdk.models.MeasurementValueObject(id=None, value=None, unit=None, type=None, representation=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
MeasurementValueObject - a model defined in Swagger
- attribute_map = {'id': 'id', 'representation': 'representation', 'type': 'type', 'unit': 'unit', 'value': 'value'}¶
- property id¶
Gets the id of this MeasurementValueObject. # noqa: E501
- Returns:
The id of this MeasurementValueObject. # noqa: E501
- Return type:
int
- property representation¶
Gets the representation of this MeasurementValueObject. # noqa: E501
- Returns:
The representation of this MeasurementValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'id': 'int', 'representation': 'str', 'type': 'str', 'unit': 'str', 'value': 'str'}¶
- property type¶
Gets the type of this MeasurementValueObject. # noqa: E501
- Returns:
The type of this MeasurementValueObject. # noqa: E501
- Return type:
str
- property unit¶
Gets the unit of this MeasurementValueObject. # noqa: E501
- Returns:
The unit of this MeasurementValueObject. # noqa: E501
- Return type:
str
- property value¶
Gets the value of this MeasurementValueObject. # noqa: E501
- Returns:
The value of this MeasurementValueObject. # noqa: E501
- Return type:
str
- class gemmapy.sdk.models.OneOfSearchResultValueObjectObjectResultObject[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
OneOfSearchResultValueObjectObjectResultObject - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.OntologyTermValueObject(uri=None, name=None, parent_terms=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
OntologyTermValueObject - a model defined in Swagger
- attribute_map = {'name': 'name', 'parent_terms': 'parentTerms', 'uri': 'uri'}¶
- property name¶
Gets the name of this OntologyTermValueObject. # noqa: E501
- Returns:
The name of this OntologyTermValueObject. # noqa: E501
- Return type:
str
- property parent_terms¶
Gets the parent_terms of this OntologyTermValueObject. # noqa: E501
- Returns:
The parent_terms of this OntologyTermValueObject. # noqa: E501
- Return type:
list[OntologyTermValueObject]
- swagger_types = {'name': 'str', 'parent_terms': 'list[OntologyTermValueObject]', 'uri': 'str'}¶
- property uri¶
Gets the uri of this OntologyTermValueObject. # noqa: E501
- Returns:
The uri of this OntologyTermValueObject. # noqa: E501
- Return type:
str
- class gemmapy.sdk.models.PaginatedResponseDataObjectCompositeSequenceValueObject(data=None, group_by=None, sort=None, offset=None, limit=None, total_elements=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
PaginatedResponseDataObjectCompositeSequenceValueObject - a model defined in Swagger
- attribute_map = {'data': 'data', 'group_by': 'groupBy', 'limit': 'limit', 'offset': 'offset', 'sort': 'sort', 'total_elements': 'totalElements'}¶
- property data¶
Gets the data of this PaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Returns:
The data of this PaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Return type:
- property group_by¶
Gets the group_by of this PaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Returns:
The group_by of this PaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Return type:
list[str]
- property limit¶
Gets the limit of this PaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Returns:
The limit of this PaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Return type:
int
- property offset¶
Gets the offset of this PaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Returns:
The offset of this PaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Return type:
int
- property sort¶
Gets the sort of this PaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Returns:
The sort of this PaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[CompositeSequenceValueObject]', 'group_by': 'list[str]', 'limit': 'int', 'offset': 'int', 'sort': 'SortValueObject', 'total_elements': 'int'}¶
- property total_elements¶
Gets the total_elements of this PaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Returns:
The total_elements of this PaginatedResponseDataObjectCompositeSequenceValueObject. # noqa: E501
- Return type:
int
- class gemmapy.sdk.models.PaginatedResponseDataObjectExpressionExperimentValueObject(data=None, group_by=None, sort=None, offset=None, limit=None, total_elements=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
PaginatedResponseDataObjectExpressionExperimentValueObject - a model defined in Swagger
- attribute_map = {'data': 'data', 'group_by': 'groupBy', 'limit': 'limit', 'offset': 'offset', 'sort': 'sort', 'total_elements': 'totalElements'}¶
- property data¶
Gets the data of this PaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The data of this PaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
- property group_by¶
Gets the group_by of this PaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The group_by of this PaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
list[str]
- property limit¶
Gets the limit of this PaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The limit of this PaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
int
- property offset¶
Gets the offset of this PaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The offset of this PaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
int
- property sort¶
Gets the sort of this PaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The sort of this PaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[ExpressionExperimentValueObject]', 'group_by': 'list[str]', 'limit': 'int', 'offset': 'int', 'sort': 'SortValueObject', 'total_elements': 'int'}¶
- property total_elements¶
Gets the total_elements of this PaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The total_elements of this PaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
int
- class gemmapy.sdk.models.PhysicalLocationValueObject(id=None, nucleotide=None, nucleotide_length=None, strand=None, bin=None, chromosome=None, taxon=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
PhysicalLocationValueObject - a model defined in Swagger
- attribute_map = {'bin': 'bin', 'chromosome': 'chromosome', 'id': 'id', 'nucleotide': 'nucleotide', 'nucleotide_length': 'nucleotideLength', 'strand': 'strand', 'taxon': 'taxon'}¶
- property bin¶
Gets the bin of this PhysicalLocationValueObject. # noqa: E501
- Returns:
The bin of this PhysicalLocationValueObject. # noqa: E501
- Return type:
int
- property chromosome¶
Gets the chromosome of this PhysicalLocationValueObject. # noqa: E501
- Returns:
The chromosome of this PhysicalLocationValueObject. # noqa: E501
- Return type:
str
- property id¶
Gets the id of this PhysicalLocationValueObject. # noqa: E501
- Returns:
The id of this PhysicalLocationValueObject. # noqa: E501
- Return type:
int
- property nucleotide¶
Gets the nucleotide of this PhysicalLocationValueObject. # noqa: E501
- Returns:
The nucleotide of this PhysicalLocationValueObject. # noqa: E501
- Return type:
int
- property nucleotide_length¶
Gets the nucleotide_length of this PhysicalLocationValueObject. # noqa: E501
- Returns:
The nucleotide_length of this PhysicalLocationValueObject. # noqa: E501
- Return type:
int
- property strand¶
Gets the strand of this PhysicalLocationValueObject. # noqa: E501
- Returns:
The strand of this PhysicalLocationValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'bin': 'int', 'chromosome': 'str', 'id': 'int', 'nucleotide': 'int', 'nucleotide_length': 'int', 'strand': 'str', 'taxon': 'TaxonValueObject'}¶
- property taxon¶
Gets the taxon of this PhysicalLocationValueObject. # noqa: E501
- Returns:
The taxon of this PhysicalLocationValueObject. # noqa: E501
- Return type:
- class gemmapy.sdk.models.Platform[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Platform - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Platform1[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Platform1 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Platform2[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Platform2 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Platform3[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Platform3 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Platform4[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Platform4 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Platform5[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Platform5 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.PlatformArg[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
PlatformArg - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Probe[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Probe - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.QuantitationType[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
QuantitationType - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.QuantitationTypeArg[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
QuantitationTypeArg - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.QuantitationTypeValueObject(id=None, description=None, general_type=None, is_background=None, is_background_subtracted=None, is_batch_corrected=None, is_masked_preferred=None, is_normalized=None, is_preferred=None, is_ratio=None, is_recomputed_from_raw_data=None, name=None, representation=None, scale=None, type=None, vector_type=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
QuantitationTypeValueObject - a model defined in Swagger
- attribute_map = {'description': 'description', 'general_type': 'generalType', 'id': 'id', 'is_background': 'isBackground', 'is_background_subtracted': 'isBackgroundSubtracted', 'is_batch_corrected': 'isBatchCorrected', 'is_masked_preferred': 'isMaskedPreferred', 'is_normalized': 'isNormalized', 'is_preferred': 'isPreferred', 'is_ratio': 'isRatio', 'is_recomputed_from_raw_data': 'isRecomputedFromRawData', 'name': 'name', 'representation': 'representation', 'scale': 'scale', 'type': 'type', 'vector_type': 'vectorType'}¶
- property description¶
Gets the description of this QuantitationTypeValueObject. # noqa: E501
- Returns:
The description of this QuantitationTypeValueObject. # noqa: E501
- Return type:
str
- property general_type¶
Gets the general_type of this QuantitationTypeValueObject. # noqa: E501
- Returns:
The general_type of this QuantitationTypeValueObject. # noqa: E501
- Return type:
str
- property id¶
Gets the id of this QuantitationTypeValueObject. # noqa: E501
- Returns:
The id of this QuantitationTypeValueObject. # noqa: E501
- Return type:
int
- property is_background¶
Gets the is_background of this QuantitationTypeValueObject. # noqa: E501
- Returns:
The is_background of this QuantitationTypeValueObject. # noqa: E501
- Return type:
bool
- property is_background_subtracted¶
Gets the is_background_subtracted of this QuantitationTypeValueObject. # noqa: E501
- Returns:
The is_background_subtracted of this QuantitationTypeValueObject. # noqa: E501
- Return type:
bool
- property is_batch_corrected¶
Gets the is_batch_corrected of this QuantitationTypeValueObject. # noqa: E501
- Returns:
The is_batch_corrected of this QuantitationTypeValueObject. # noqa: E501
- Return type:
bool
- property is_masked_preferred¶
Gets the is_masked_preferred of this QuantitationTypeValueObject. # noqa: E501
- Returns:
The is_masked_preferred of this QuantitationTypeValueObject. # noqa: E501
- Return type:
bool
- property is_normalized¶
Gets the is_normalized of this QuantitationTypeValueObject. # noqa: E501
- Returns:
The is_normalized of this QuantitationTypeValueObject. # noqa: E501
- Return type:
bool
- property is_preferred¶
Gets the is_preferred of this QuantitationTypeValueObject. # noqa: E501
- Returns:
The is_preferred of this QuantitationTypeValueObject. # noqa: E501
- Return type:
bool
- property is_ratio¶
Gets the is_ratio of this QuantitationTypeValueObject. # noqa: E501
- Returns:
The is_ratio of this QuantitationTypeValueObject. # noqa: E501
- Return type:
bool
- property is_recomputed_from_raw_data¶
Gets the is_recomputed_from_raw_data of this QuantitationTypeValueObject. # noqa: E501
- Returns:
The is_recomputed_from_raw_data of this QuantitationTypeValueObject. # noqa: E501
- Return type:
bool
- property name¶
Gets the name of this QuantitationTypeValueObject. # noqa: E501
- Returns:
The name of this QuantitationTypeValueObject. # noqa: E501
- Return type:
str
- property representation¶
Gets the representation of this QuantitationTypeValueObject. # noqa: E501
- Returns:
The representation of this QuantitationTypeValueObject. # noqa: E501
- Return type:
str
- property scale¶
Gets the scale of this QuantitationTypeValueObject. # noqa: E501
- Returns:
The scale of this QuantitationTypeValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'description': 'str', 'general_type': 'str', 'id': 'int', 'is_background': 'bool', 'is_background_subtracted': 'bool', 'is_batch_corrected': 'bool', 'is_masked_preferred': 'bool', 'is_normalized': 'bool', 'is_preferred': 'bool', 'is_ratio': 'bool', 'is_recomputed_from_raw_data': 'bool', 'name': 'str', 'representation': 'str', 'scale': 'str', 'type': 'str', 'vector_type': 'str'}¶
- property type¶
Gets the type of this QuantitationTypeValueObject. # noqa: E501
- Returns:
The type of this QuantitationTypeValueObject. # noqa: E501
- Return type:
str
- property vector_type¶
Gets the vector_type of this QuantitationTypeValueObject. # noqa: E501
- Returns:
The vector_type of this QuantitationTypeValueObject. # noqa: E501
- Return type:
str
- class gemmapy.sdk.models.QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject(data=None, query=None, filter=None, group_by=None, sort=None, offset=None, limit=None, total_elements=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject - a model defined in Swagger
- attribute_map = {'data': 'data', 'filter': 'filter', 'group_by': 'groupBy', 'limit': 'limit', 'offset': 'offset', 'query': 'query', 'sort': 'sort', 'total_elements': 'totalElements'}¶
- property data¶
Gets the data of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The data of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
- property filter¶
Gets the filter of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The filter of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- property group_by¶
Gets the group_by of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The group_by of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
list[str]
- property limit¶
Gets the limit of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The limit of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
int
- property offset¶
Gets the offset of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The offset of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
int
- property query¶
Gets the query of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The query of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
str
- property sort¶
Gets the sort of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The sort of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[ExpressionExperimentValueObject]', 'filter': 'str', 'group_by': 'list[str]', 'limit': 'int', 'offset': 'int', 'query': 'str', 'sort': 'SortValueObject', 'total_elements': 'int'}¶
- property total_elements¶
Gets the total_elements of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The total_elements of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
int
- class gemmapy.sdk.models.QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject(data=None, query=None, filter=None, group_by=None, sort=None, offset=None, limit=None, total_elements=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject - a model defined in Swagger
- attribute_map = {'data': 'data', 'filter': 'filter', 'group_by': 'groupBy', 'limit': 'limit', 'offset': 'offset', 'query': 'query', 'sort': 'sort', 'total_elements': 'totalElements'}¶
- property data¶
Gets the data of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The data of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
- property filter¶
Gets the filter of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The filter of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
str
- property group_by¶
Gets the group_by of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The group_by of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
list[str]
- property limit¶
Gets the limit of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The limit of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
int
- property offset¶
Gets the offset of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The offset of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
int
- property query¶
Gets the query of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The query of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
str
- property sort¶
Gets the sort of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The sort of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[ExpressionExperimentWithSearchResultValueObject]', 'filter': 'str', 'group_by': 'list[str]', 'limit': 'int', 'offset': 'int', 'query': 'str', 'sort': 'SortValueObject', 'total_elements': 'int'}¶
- property total_elements¶
Gets the total_elements of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Returns:
The total_elements of this QueriedAndFilteredAndPaginatedResponseDataObjectExpressionExperimentWithSearchResultValueObject. # noqa: E501
- Return type:
int
- class gemmapy.sdk.models.QueriedAndFilteredResponseDataObjectCategoryWithUsageStatisticsValueObject(data=None, query=None, filter=None, group_by=None, sort=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
QueriedAndFilteredResponseDataObjectCategoryWithUsageStatisticsValueObject - a model defined in Swagger
- attribute_map = {'data': 'data', 'filter': 'filter', 'group_by': 'groupBy', 'query': 'query', 'sort': 'sort'}¶
- property data¶
Gets the data of this QueriedAndFilteredResponseDataObjectCategoryWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The data of this QueriedAndFilteredResponseDataObjectCategoryWithUsageStatisticsValueObject. # noqa: E501
- Return type:
- property filter¶
Gets the filter of this QueriedAndFilteredResponseDataObjectCategoryWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The filter of this QueriedAndFilteredResponseDataObjectCategoryWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property group_by¶
Gets the group_by of this QueriedAndFilteredResponseDataObjectCategoryWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The group_by of this QueriedAndFilteredResponseDataObjectCategoryWithUsageStatisticsValueObject. # noqa: E501
- Return type:
list[str]
- property query¶
Gets the query of this QueriedAndFilteredResponseDataObjectCategoryWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The query of this QueriedAndFilteredResponseDataObjectCategoryWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property sort¶
Gets the sort of this QueriedAndFilteredResponseDataObjectCategoryWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The sort of this QueriedAndFilteredResponseDataObjectCategoryWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'data': 'list[CategoryWithUsageStatisticsValueObject]', 'filter': 'str', 'group_by': 'list[str]', 'query': 'str', 'sort': 'str'}¶
- class gemmapy.sdk.models.QueriedAndFilteredResponseDataObjectTaxonWithUsageStatisticsValueObject(data=None, query=None, filter=None, group_by=None, sort=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
QueriedAndFilteredResponseDataObjectTaxonWithUsageStatisticsValueObject - a model defined in Swagger
- attribute_map = {'data': 'data', 'filter': 'filter', 'group_by': 'groupBy', 'query': 'query', 'sort': 'sort'}¶
- property data¶
Gets the data of this QueriedAndFilteredResponseDataObjectTaxonWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The data of this QueriedAndFilteredResponseDataObjectTaxonWithUsageStatisticsValueObject. # noqa: E501
- Return type:
- property filter¶
Gets the filter of this QueriedAndFilteredResponseDataObjectTaxonWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The filter of this QueriedAndFilteredResponseDataObjectTaxonWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property group_by¶
Gets the group_by of this QueriedAndFilteredResponseDataObjectTaxonWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The group_by of this QueriedAndFilteredResponseDataObjectTaxonWithUsageStatisticsValueObject. # noqa: E501
- Return type:
list[str]
- property query¶
Gets the query of this QueriedAndFilteredResponseDataObjectTaxonWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The query of this QueriedAndFilteredResponseDataObjectTaxonWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property sort¶
Gets the sort of this QueriedAndFilteredResponseDataObjectTaxonWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The sort of this QueriedAndFilteredResponseDataObjectTaxonWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'data': 'list[TaxonWithUsageStatisticsValueObject]', 'filter': 'str', 'group_by': 'list[str]', 'query': 'str', 'sort': 'str'}¶
- class gemmapy.sdk.models.QueryArg[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
QueryArg - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.ResponseDataObjectApiInfoValueObject(data=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ResponseDataObjectApiInfoValueObject - a model defined in Swagger
- attribute_map = {'data': 'data'}¶
- property data¶
Gets the data of this ResponseDataObjectApiInfoValueObject. # noqa: E501
- Returns:
The data of this ResponseDataObjectApiInfoValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'ApiInfoValueObject'}¶
- class gemmapy.sdk.models.ResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject(data=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject - a model defined in Swagger
- attribute_map = {'data': 'data'}¶
- property data¶
Gets the data of this ResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Returns:
The data of this ResponseDataObjectDifferentialExpressionAnalysisResultSetValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'DifferentialExpressionAnalysisResultSetValueObject'}¶
- class gemmapy.sdk.models.ResponseDataObjectListAnnotationSearchResultValueObject(data=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ResponseDataObjectListAnnotationSearchResultValueObject - a model defined in Swagger
- attribute_map = {'data': 'data'}¶
- property data¶
Gets the data of this ResponseDataObjectListAnnotationSearchResultValueObject. # noqa: E501
- Returns:
The data of this ResponseDataObjectListAnnotationSearchResultValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[AnnotationSearchResultValueObject]'}¶
- class gemmapy.sdk.models.ResponseDataObjectListArrayDesignValueObject(data=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ResponseDataObjectListArrayDesignValueObject - a model defined in Swagger
- attribute_map = {'data': 'data'}¶
- property data¶
Gets the data of this ResponseDataObjectListArrayDesignValueObject. # noqa: E501
- Returns:
The data of this ResponseDataObjectListArrayDesignValueObject. # noqa: E501
- Return type:
list[ArrayDesignValueObject]
- swagger_types = {'data': 'list[ArrayDesignValueObject]'}¶
- class gemmapy.sdk.models.ResponseDataObjectListBioAssayValueObject(data=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ResponseDataObjectListBioAssayValueObject - a model defined in Swagger
- attribute_map = {'data': 'data'}¶
- property data¶
Gets the data of this ResponseDataObjectListBioAssayValueObject. # noqa: E501
- Returns:
The data of this ResponseDataObjectListBioAssayValueObject. # noqa: E501
- Return type:
list[BioAssayValueObject]
- swagger_types = {'data': 'list[BioAssayValueObject]'}¶
- class gemmapy.sdk.models.ResponseDataObjectListDifferentialExpressionAnalysisValueObject(data=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ResponseDataObjectListDifferentialExpressionAnalysisValueObject - a model defined in Swagger
- attribute_map = {'data': 'data'}¶
- property data¶
Gets the data of this ResponseDataObjectListDifferentialExpressionAnalysisValueObject. # noqa: E501
- Returns:
The data of this ResponseDataObjectListDifferentialExpressionAnalysisValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[DifferentialExpressionAnalysisValueObject]'}¶
- class gemmapy.sdk.models.ResponseDataObjectListExperimentExpressionLevelsValueObject(data=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ResponseDataObjectListExperimentExpressionLevelsValueObject - a model defined in Swagger
- attribute_map = {'data': 'data'}¶
- property data¶
Gets the data of this ResponseDataObjectListExperimentExpressionLevelsValueObject. # noqa: E501
- Returns:
The data of this ResponseDataObjectListExperimentExpressionLevelsValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[ExperimentExpressionLevelsValueObject]'}¶
- class gemmapy.sdk.models.ResponseDataObjectListGeneOntologyTermValueObject(data=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ResponseDataObjectListGeneOntologyTermValueObject - a model defined in Swagger
- attribute_map = {'data': 'data'}¶
- property data¶
Gets the data of this ResponseDataObjectListGeneOntologyTermValueObject. # noqa: E501
- Returns:
The data of this ResponseDataObjectListGeneOntologyTermValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[GeneOntologyTermValueObject]'}¶
- class gemmapy.sdk.models.ResponseDataObjectListGeneValueObject(data=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ResponseDataObjectListGeneValueObject - a model defined in Swagger
- attribute_map = {'data': 'data'}¶
- property data¶
Gets the data of this ResponseDataObjectListGeneValueObject. # noqa: E501
- Returns:
The data of this ResponseDataObjectListGeneValueObject. # noqa: E501
- Return type:
list[GeneValueObject]
- swagger_types = {'data': 'list[GeneValueObject]'}¶
- class gemmapy.sdk.models.ResponseDataObjectListPhysicalLocationValueObject(data=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ResponseDataObjectListPhysicalLocationValueObject - a model defined in Swagger
- attribute_map = {'data': 'data'}¶
- property data¶
Gets the data of this ResponseDataObjectListPhysicalLocationValueObject. # noqa: E501
- Returns:
The data of this ResponseDataObjectListPhysicalLocationValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[PhysicalLocationValueObject]'}¶
- class gemmapy.sdk.models.ResponseDataObjectListTaxonValueObject(data=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ResponseDataObjectListTaxonValueObject - a model defined in Swagger
- attribute_map = {'data': 'data'}¶
- property data¶
Gets the data of this ResponseDataObjectListTaxonValueObject. # noqa: E501
- Returns:
The data of this ResponseDataObjectListTaxonValueObject. # noqa: E501
- Return type:
list[TaxonValueObject]
- swagger_types = {'data': 'list[TaxonValueObject]'}¶
- class gemmapy.sdk.models.ResponseDataObjectLong(data=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ResponseDataObjectLong - a model defined in Swagger
- attribute_map = {'data': 'data'}¶
- property data¶
Gets the data of this ResponseDataObjectLong. # noqa: E501
- Returns:
The data of this ResponseDataObjectLong. # noqa: E501
- Return type:
int
- swagger_types = {'data': 'int'}¶
- class gemmapy.sdk.models.ResponseDataObjectSetAnnotationValueObject(data=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ResponseDataObjectSetAnnotationValueObject - a model defined in Swagger
- attribute_map = {'data': 'data'}¶
- property data¶
Gets the data of this ResponseDataObjectSetAnnotationValueObject. # noqa: E501
- Returns:
The data of this ResponseDataObjectSetAnnotationValueObject. # noqa: E501
- Return type:
list[AnnotationValueObject]
- swagger_types = {'data': 'list[AnnotationValueObject]'}¶
- class gemmapy.sdk.models.ResponseDataObjectSetQuantitationTypeValueObject(data=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ResponseDataObjectSetQuantitationTypeValueObject - a model defined in Swagger
- attribute_map = {'data': 'data'}¶
- property data¶
Gets the data of this ResponseDataObjectSetQuantitationTypeValueObject. # noqa: E501
- Returns:
The data of this ResponseDataObjectSetQuantitationTypeValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[QuantitationTypeValueObject]'}¶
- class gemmapy.sdk.models.ResponseDataObjectSimpleSVDValueObject(data=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ResponseDataObjectSimpleSVDValueObject - a model defined in Swagger
- attribute_map = {'data': 'data'}¶
- property data¶
Gets the data of this ResponseDataObjectSimpleSVDValueObject. # noqa: E501
- Returns:
The data of this ResponseDataObjectSimpleSVDValueObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'SimpleSVDValueObject'}¶
- class gemmapy.sdk.models.ResponseErrorObject(error=None, api_version=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
ResponseErrorObject - a model defined in Swagger
- property api_version¶
Gets the api_version of this ResponseErrorObject. # noqa: E501
- Returns:
The api_version of this ResponseErrorObject. # noqa: E501
- Return type:
str
- attribute_map = {'api_version': 'apiVersion', 'error': 'error'}¶
- property error¶
Gets the error of this ResponseErrorObject. # noqa: E501
- Returns:
The error of this ResponseErrorObject. # noqa: E501
- Return type:
- swagger_types = {'api_version': 'str', 'error': 'WellComposedErrorBody'}¶
- class gemmapy.sdk.models.SearchResultType[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
SearchResultType - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.SearchResultValueObjectExpressionExperimentValueObject(result_id=None, result_type=None, score=None, highlights=None, result_object=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
SearchResultValueObjectExpressionExperimentValueObject - a model defined in Swagger
- attribute_map = {'highlights': 'highlights', 'result_id': 'resultId', 'result_object': 'resultObject', 'result_type': 'resultType', 'score': 'score'}¶
- property highlights¶
Gets the highlights of this SearchResultValueObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The highlights of this SearchResultValueObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
dict(str, str)
- property result_id¶
Gets the result_id of this SearchResultValueObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The result_id of this SearchResultValueObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
int
- property result_object¶
Gets the result_object of this SearchResultValueObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The result_object of this SearchResultValueObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
- property result_type¶
Gets the result_type of this SearchResultValueObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The result_type of this SearchResultValueObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
- property score¶
Gets the score of this SearchResultValueObjectExpressionExperimentValueObject. # noqa: E501
- Returns:
The score of this SearchResultValueObjectExpressionExperimentValueObject. # noqa: E501
- Return type:
float
- swagger_types = {'highlights': 'dict(str, str)', 'result_id': 'int', 'result_object': 'ExpressionExperimentValueObject', 'result_type': 'SearchResultType', 'score': 'float'}¶
- class gemmapy.sdk.models.SearchResultValueObjectObject(result_id=None, result_type=None, score=None, highlights=None, result_object=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
SearchResultValueObjectObject - a model defined in Swagger
- attribute_map = {'highlights': 'highlights', 'result_id': 'resultId', 'result_object': 'resultObject', 'result_type': 'resultType', 'score': 'score'}¶
- property highlights¶
Gets the highlights of this SearchResultValueObjectObject. # noqa: E501
- Returns:
The highlights of this SearchResultValueObjectObject. # noqa: E501
- Return type:
dict(str, str)
- property result_id¶
Gets the result_id of this SearchResultValueObjectObject. # noqa: E501
- Returns:
The result_id of this SearchResultValueObjectObject. # noqa: E501
- Return type:
int
- property result_object¶
Gets the result_object of this SearchResultValueObjectObject. # noqa: E501
- Returns:
The result_object of this SearchResultValueObjectObject. # noqa: E501
- Return type:
- property result_type¶
Gets the result_type of this SearchResultValueObjectObject. # noqa: E501
- Returns:
The result_type of this SearchResultValueObjectObject. # noqa: E501
- Return type:
- property score¶
Gets the score of this SearchResultValueObjectObject. # noqa: E501
- Returns:
The score of this SearchResultValueObjectObject. # noqa: E501
- Return type:
float
- swagger_types = {'highlights': 'dict(str, str)', 'result_id': 'int', 'result_object': 'OneOfSearchResultValueObjectObjectResultObject', 'result_type': 'SearchResultType', 'score': 'float'}¶
- class gemmapy.sdk.models.SearchResultsResponseDataObject(data=None, search_settings=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
SearchResultsResponseDataObject - a model defined in Swagger
- attribute_map = {'data': 'data', 'search_settings': 'searchSettings'}¶
- property data¶
Gets the data of this SearchResultsResponseDataObject. # noqa: E501
- Returns:
The data of this SearchResultsResponseDataObject. # noqa: E501
- Return type:
- property search_settings¶
Gets the search_settings of this SearchResultsResponseDataObject. # noqa: E501
- Returns:
The search_settings of this SearchResultsResponseDataObject. # noqa: E501
- Return type:
- swagger_types = {'data': 'list[SearchResultValueObjectObject]', 'search_settings': 'SearchSettingsValueObject'}¶
- class gemmapy.sdk.models.SearchSettingsValueObject(query=None, result_types=None, taxon=None, platform=None, max_results=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
SearchSettingsValueObject - a model defined in Swagger
- attribute_map = {'max_results': 'maxResults', 'platform': 'platform', 'query': 'query', 'result_types': 'resultTypes', 'taxon': 'taxon'}¶
- property max_results¶
Gets the max_results of this SearchSettingsValueObject. # noqa: E501
- Returns:
The max_results of this SearchSettingsValueObject. # noqa: E501
- Return type:
int
- property platform¶
Gets the platform of this SearchSettingsValueObject. # noqa: E501
- Returns:
The platform of this SearchSettingsValueObject. # noqa: E501
- Return type:
- property query¶
Gets the query of this SearchSettingsValueObject. # noqa: E501
- Returns:
The query of this SearchSettingsValueObject. # noqa: E501
- Return type:
str
- property result_types¶
Gets the result_types of this SearchSettingsValueObject. # noqa: E501
- Returns:
The result_types of this SearchSettingsValueObject. # noqa: E501
- Return type:
list[SearchResultType]
- swagger_types = {'max_results': 'int', 'platform': 'ArrayDesignValueObject', 'query': 'str', 'result_types': 'list[SearchResultType]', 'taxon': 'TaxonValueObject'}¶
- property taxon¶
Gets the taxon of this SearchSettingsValueObject. # noqa: E501
- Returns:
The taxon of this SearchSettingsValueObject. # noqa: E501
- Return type:
- class gemmapy.sdk.models.SimpleSVDValueObject(bio_material_ids=None, variances=None, vmatrix=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
SimpleSVDValueObject - a model defined in Swagger
- attribute_map = {'bio_material_ids': 'bioMaterialIds', 'variances': 'variances', 'vmatrix': 'vmatrix'}¶
- property bio_material_ids¶
Gets the bio_material_ids of this SimpleSVDValueObject. # noqa: E501
- Returns:
The bio_material_ids of this SimpleSVDValueObject. # noqa: E501
- Return type:
list[int]
- swagger_types = {'bio_material_ids': 'list[int]', 'variances': 'list[float]', 'vmatrix': 'list[list[float]]'}¶
- property variances¶
Gets the variances of this SimpleSVDValueObject. # noqa: E501
- Returns:
The variances of this SimpleSVDValueObject. # noqa: E501
- Return type:
list[float]
- property vmatrix¶
Gets the vmatrix of this SimpleSVDValueObject. # noqa: E501
- Returns:
The vmatrix of this SimpleSVDValueObject. # noqa: E501
- Return type:
list[list[float]]
- class gemmapy.sdk.models.SortArgArrayDesign[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
SortArgArrayDesign - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.SortArgExpressionAnalysisResultSet[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
SortArgExpressionAnalysisResultSet - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.SortArgExpressionExperiment[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
SortArgExpressionExperiment - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.SortArgTaxon[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
SortArgTaxon - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.SortValueObject(order_by=None, direction=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
SortValueObject - a model defined in Swagger
- attribute_map = {'direction': 'direction', 'order_by': 'orderBy'}¶
- property direction¶
Gets the direction of this SortValueObject. # noqa: E501
- Returns:
The direction of this SortValueObject. # noqa: E501
- Return type:
str
- property order_by¶
Gets the order_by of this SortValueObject. # noqa: E501
- Returns:
The order_by of this SortValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'direction': 'str', 'order_by': 'str'}¶
- class gemmapy.sdk.models.StatementValueObject(category=None, category_uri=None, subject=None, subject_uri=None, predicate=None, predicate_uri=None, object=None, object_uri=None, subject_id=None, object_id=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
StatementValueObject - a model defined in Swagger
- attribute_map = {'category': 'category', 'category_uri': 'categoryUri', 'object': 'object', 'object_id': 'objectId', 'object_uri': 'objectUri', 'predicate': 'predicate', 'predicate_uri': 'predicateUri', 'subject': 'subject', 'subject_id': 'subjectId', 'subject_uri': 'subjectUri'}¶
- property category¶
Gets the category of this StatementValueObject. # noqa: E501
- Returns:
The category of this StatementValueObject. # noqa: E501
- Return type:
str
- property category_uri¶
Gets the category_uri of this StatementValueObject. # noqa: E501
- Returns:
The category_uri of this StatementValueObject. # noqa: E501
- Return type:
str
- property object¶
Gets the object of this StatementValueObject. # noqa: E501
- Returns:
The object of this StatementValueObject. # noqa: E501
- Return type:
str
- property object_id¶
Gets the object_id of this StatementValueObject. # noqa: E501
- Returns:
The object_id of this StatementValueObject. # noqa: E501
- Return type:
str
- property object_uri¶
Gets the object_uri of this StatementValueObject. # noqa: E501
- Returns:
The object_uri of this StatementValueObject. # noqa: E501
- Return type:
str
- property predicate¶
Gets the predicate of this StatementValueObject. # noqa: E501
- Returns:
The predicate of this StatementValueObject. # noqa: E501
- Return type:
str
- property predicate_uri¶
Gets the predicate_uri of this StatementValueObject. # noqa: E501
- Returns:
The predicate_uri of this StatementValueObject. # noqa: E501
- Return type:
str
- property subject¶
Gets the subject of this StatementValueObject. # noqa: E501
- Returns:
The subject of this StatementValueObject. # noqa: E501
- Return type:
str
- property subject_id¶
Gets the subject_id of this StatementValueObject. # noqa: E501
- Returns:
The subject_id of this StatementValueObject. # noqa: E501
- Return type:
str
- property subject_uri¶
Gets the subject_uri of this StatementValueObject. # noqa: E501
- Returns:
The subject_uri of this StatementValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'category': 'str', 'category_uri': 'str', 'object': 'str', 'object_id': 'str', 'object_uri': 'str', 'predicate': 'str', 'predicate_uri': 'str', 'subject': 'str', 'subject_id': 'str', 'subject_uri': 'str'}¶
- class gemmapy.sdk.models.Taxon[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Taxon - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Taxon1[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Taxon1 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Taxon2[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Taxon2 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Taxon3[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Taxon3 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Taxon4[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Taxon4 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Taxon5[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Taxon5 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.Taxon6[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Taxon6 - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.TaxonArg[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
TaxonArg - a model defined in Swagger
- attribute_map = {}¶
- swagger_types = {}¶
- class gemmapy.sdk.models.TaxonValueObject(id=None, scientific_name=None, common_name=None, ncbi_id=None, external_database=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
TaxonValueObject - a model defined in Swagger
- attribute_map = {'common_name': 'commonName', 'external_database': 'externalDatabase', 'id': 'id', 'ncbi_id': 'ncbiId', 'scientific_name': 'scientificName'}¶
- property common_name¶
Gets the common_name of this TaxonValueObject. # noqa: E501
- Returns:
The common_name of this TaxonValueObject. # noqa: E501
- Return type:
str
- property external_database¶
Gets the external_database of this TaxonValueObject. # noqa: E501
- Returns:
The external_database of this TaxonValueObject. # noqa: E501
- Return type:
- property id¶
Gets the id of this TaxonValueObject. # noqa: E501
- Returns:
The id of this TaxonValueObject. # noqa: E501
- Return type:
int
- property ncbi_id¶
Gets the ncbi_id of this TaxonValueObject. # noqa: E501
- Returns:
The ncbi_id of this TaxonValueObject. # noqa: E501
- Return type:
int
- property scientific_name¶
Gets the scientific_name of this TaxonValueObject. # noqa: E501
- Returns:
The scientific_name of this TaxonValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'common_name': 'str', 'external_database': 'ExternalDatabaseValueObject', 'id': 'int', 'ncbi_id': 'int', 'scientific_name': 'str'}¶
- class gemmapy.sdk.models.TaxonWithUsageStatisticsValueObject(id=None, scientific_name=None, common_name=None, ncbi_id=None, external_database=None, number_of_expression_experiments=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
TaxonWithUsageStatisticsValueObject - a model defined in Swagger
- attribute_map = {'common_name': 'commonName', 'external_database': 'externalDatabase', 'id': 'id', 'ncbi_id': 'ncbiId', 'number_of_expression_experiments': 'numberOfExpressionExperiments', 'scientific_name': 'scientificName'}¶
- property common_name¶
Gets the common_name of this TaxonWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The common_name of this TaxonWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- property external_database¶
Gets the external_database of this TaxonWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The external_database of this TaxonWithUsageStatisticsValueObject. # noqa: E501
- Return type:
- property id¶
Gets the id of this TaxonWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The id of this TaxonWithUsageStatisticsValueObject. # noqa: E501
- Return type:
int
- property ncbi_id¶
Gets the ncbi_id of this TaxonWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The ncbi_id of this TaxonWithUsageStatisticsValueObject. # noqa: E501
- Return type:
int
- property number_of_expression_experiments¶
Gets the number_of_expression_experiments of this TaxonWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The number_of_expression_experiments of this TaxonWithUsageStatisticsValueObject. # noqa: E501
- Return type:
int
- property scientific_name¶
Gets the scientific_name of this TaxonWithUsageStatisticsValueObject. # noqa: E501
- Returns:
The scientific_name of this TaxonWithUsageStatisticsValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'common_name': 'str', 'external_database': 'ExternalDatabaseValueObject', 'id': 'int', 'ncbi_id': 'int', 'number_of_expression_experiments': 'int', 'scientific_name': 'str'}¶
- class gemmapy.sdk.models.VectorElementValueObject(design_element_name=None, bio_assay_expression_levels=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
VectorElementValueObject - a model defined in Swagger
- attribute_map = {'bio_assay_expression_levels': 'bioAssayExpressionLevels', 'design_element_name': 'designElementName'}¶
- property bio_assay_expression_levels¶
Gets the bio_assay_expression_levels of this VectorElementValueObject. # noqa: E501
- Returns:
The bio_assay_expression_levels of this VectorElementValueObject. # noqa: E501
- Return type:
dict(str, float)
- property design_element_name¶
Gets the design_element_name of this VectorElementValueObject. # noqa: E501
- Returns:
The design_element_name of this VectorElementValueObject. # noqa: E501
- Return type:
str
- swagger_types = {'bio_assay_expression_levels': 'dict(str, float)', 'design_element_name': 'str'}¶
- class gemmapy.sdk.models.WellComposedErrorBody(code=None, message=None, errors=None)[source]¶
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
WellComposedErrorBody - a model defined in Swagger
- attribute_map = {'code': 'code', 'errors': 'errors', 'message': 'message'}¶
- property code¶
Gets the code of this WellComposedErrorBody. # noqa: E501
- Returns:
The code of this WellComposedErrorBody. # noqa: E501
- Return type:
int
- property errors¶
Gets the errors of this WellComposedErrorBody. # noqa: E501
- Returns:
The errors of this WellComposedErrorBody. # noqa: E501
- Return type:
dict(str, str)
- property message¶
Gets the message of this WellComposedErrorBody. # noqa: E501
- Returns:
The message of this WellComposedErrorBody. # noqa: E501
- Return type:
str
- swagger_types = {'code': 'int', 'errors': 'dict(str, str)', 'message': 'str'}¶