omxware.entities package¶
Submodules¶
omxware.entities.Domain module¶
-
class
omxware.entities.Domain.
Domain
(connecthdr: 'omxware.config.Connection', domain)[source]¶ Bases:
omxware.entities.Entity.Entity
OMXWare Domain Entity Class
-
genus
(page_size=25, page_number=1)[source]¶ Get all the associated Genera for this Domain
- Parameters:
param page_number: Page Number type page_number: int param page_size: Results page size type page_size: int - Returns:
return: OmxResponse: Genus
-
go
(page_size=25, page_number=1)[source]¶ Get all the associated GO terms for this Domain
- Parameters:
param page_number: Page Number type page_number: int param page_size: Results page size type page_size: int - Returns:
return: OmxResponse: GO
-
ipr
(page_size=25, page_number=1)[source]¶ Get all the associated IPR codes for this Domain
- Parameters:
param page_number: Page Number type page_number: int param page_size: Results page size type page_size: int - Returns:
return: OmxResponse: Iprs
-
omxware.entities.Entity module¶
omxware.entities.Gene module¶
-
class
omxware.entities.Gene.
Gene
(connecthdr: 'omxware.config.Connection', gene)[source]¶ Bases:
omxware.entities.Entity.Entity
OMXWare Gene Entity Class
-
genomes
(page_size=25, page_number=1)[source]¶ Get associated Genomes for this Gene
- Parameters:
param page_number: Page Number type page_number: int param page_size: Results page size type page_size: int - Returns:
return: OmxResponse: Genomes
-
genus
(page_size=25, page_number=1)[source]¶ Get all the associated Genera for this Gene
- Parameters:
param page_number: Page Number type page_number: int param page_size: Results page size type page_size: int - Returns:
return: OmxResponse: Genus
-
go
(page_size=25, page_number=1)[source]¶ Get all the associated GO terms for this Gene
- Parameters:
param page_number: Page Number type page_number: int param page_size: Results page size type page_size: int - Returns:
return: OmxResponse: GO
-
omxware.entities.Genome module¶
-
class
omxware.entities.Genome.
Genome
(connecthdr: 'omxware.config.Connection', genome)[source]¶ Bases:
omxware.entities.Entity.Entity
OMXWare Genome Entity Class
-
genes
(page_size=25, page_number=1)[source]¶ Get OMXWare Genes for the Genome
- Parameters:
param page_number: Page Number type page_number: int param page_size: Results page size type page_size: int - Returns:
return: OmxResponse: Genes
-
genome_type
()[source]¶ Get this Genome’s type. Will be one of { ‘REFSEQ’, ‘SRA’, ‘GENBANK’ }
- Returns:
return: str : Genome type
-
genus
(page_size=25, page_number=1)[source]¶ Get OMXWare Genera the Genome
- Parameters:
param page_number: Page Number type page_number: int param page_size: Results page size type page_size: int - Returns:
return: OmxResponse: Genus
-
metadata
(type='biosample')[source]¶ Get Genome metadata
- Parameters:
param type: Genome metadata. Must be one of [‘biosample’] type type: str - Returns:
- OmxResponse: Genome Metadata :return: dict: Genome metadata
-
omxware.entities.Genus module¶
-
class
omxware.entities.Genus.
Genus
(connecthdr: 'omxware.config.Connection', genus)[source]¶ Bases:
omxware.entities.Entity.Entity
OMXWare Genus Entity Class
-
domains
(page_size=25, page_number=1)[source]¶ Get OMXWare Domains for the Genus
- Parameters:
param page_number: Page Number type page_number: int param page_size: Results page size type page_size: int - Returns:
return: OmxResponse: Domains
-
genes
(page_size=25, page_number=1)[source]¶ Get OMXWare Genes for the Genus
- Parameters:
param page_number: Page Number type page_number: int param page_size: Results page size type page_size: int - Returns:
return: OmxResponse: Genes
-
omxware.entities.GoTerm module¶
-
class
omxware.entities.GoTerm.
Go
(connecthdr: 'omxware.config.Connection', go)[source]¶ Bases:
omxware.entities.Entity.Entity
OMXWare GO Entity Class
-
domains
(page_size=25, page_number=1)[source]¶ Get OMXWare Domains for this GO Term
- Parameters:
param page_number: Page Number type page_number: int param page_size: Results page size type page_size: int - Returns:
return: OmxResponse: Domains
-
omxware.entities.IprCode module¶
-
class
omxware.entities.IprCode.
Ipr
(connecthdr: 'omxware.config.Connection', ipr)[source]¶ Bases:
omxware.entities.Entity.Entity
OMXWare IPR Entity Class
-
domains
(page_size=25, page_number=1)[source]¶ Get OMXWare Domains for this IPR code
- Parameters:
param page_number: Page Number type page_number: int param page_size: Results page size type page_size: int - Returns:
return: OmxResponse: Domains
-
omxware.entities.Protein module¶
-
class
omxware.entities.Protein.
Protein
(connecthdr: 'omxware.config.Connection', protein)[source]¶ Bases:
omxware.entities.Entity.Entity
OMXWare Protein Entity Class
-
domains
(page_size=25, page_number=1)[source]¶ Get all the associated Domains for this Protein
- Parameters:
param page_number: Page Number type page_number: int param page_size: Results page size type page_size: int - Returns:
return: OmxResponse: Domains
-
genomes
(page_size=25, page_number=1)[source]¶ Get all the associated Genomes for this Protein
- Parameters:
param page_number: Page Number type page_number: int param page_size: Results page size type page_size: int - Returns:
return: OmxResponse: Genomes
-
genus
(page_size=25, page_number=1)[source]¶ Get all the associated Genera for this Protein
- Parameters:
param page_number: Page Number type page_number: int param page_size: Results page size type page_size: int - Returns:
return: OmxResponse: Genus
-
go
(page_size=25, page_number=1)[source]¶ Get all the associated GO terms for this Protein
- Parameters:
param page_number: Page Number type page_number: int param page_size: Results page size type page_size: int - Returns:
return: OmxResponse: GO
-
omxware.entities.User module¶
-
class
omxware.entities.User.
User
(connecthdr: 'omxware.config.Connection', user)[source]¶ Bases:
omxware.entities.Entity.Entity
OMXWare User Entity Class