|
ensembl-hive
2.8.1
|
Inheritance diagram for Bio::EnsEMBL::DBSQL::GenomeContainer:
This module is responsible for fetching and storing genome-wide information. Genome is an abstract object which contains information linking the species, the assembly and the ensembl annotation.
Definition at line 37 of file GenomeContainer.pm.
| protected Int Bio::EnsEMBL::DBSQL::GenomeContainer::_get_count | ( | ) |
Arg [1] : none Example :
Description: Internal method to return a count for a given attribute code Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| protected Int Bio::EnsEMBL::DBSQL::GenomeContainer::_get_length | ( | ) |
Arg [1] : none Example :
Description: Internal method to return the length for a type of slices Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| protected Bio::EnsEMBL::DBSQL::MetaContainer Bio::EnsEMBL::DBSQL::GenomeContainer::_meta_container | ( | ) |
Arg [1] : none Example :
Description: Internal method to return a MetaContainer object for the genome Returntype : Bio::EnsEMBL::DBSQL::MetaContainer Exceptions : none Caller : general Status : Stable
Code:
| protected Bio::EnsEMBL::DBSQL::GenomeContainer::_obj_from_sth | ( | ) |
Undocumented method
Code:
| public ArrayRef Bio::EnsEMBL::DBSQL::GenomeContainer::fetch_all_statistics | ( | ) |
Arg [1] : none Example :
Description: Retrieve all entries stored in the genome_statistics table Returntype : ArrayRef of Bio::EnsEMBL::Genome Exceptions : none Caller : general Status : Stable
Code:
| public Bio::EnsEMBL::Genome Bio::EnsEMBL::DBSQL::GenomeContainer::fetch_by_statistic | ( | ) |
Arg [1] : string $statistic Example :
Description: Returns a Genome object for a given statistic Returntype : Bio::EnsEMBL::Genome Exceptions : none Caller : general Status : Stable
Code:
| public String Bio::EnsEMBL::DBSQL::GenomeContainer::get_accession | ( | ) |
Arg [1] : (optional) assembly accession Example :
Description: Getter/setter for the accession of the assembly currently used
Returntype : string Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_alt_coding_count | ( | ) |
Arg [1] : (optional) alt coding count Example :
Description: Getter/setter for the number of coding genes on alternate sequences
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_alt_lnoncoding_count | ( | ) |
Arg [1] : (optional) alt long non coding count Example :
Description: Getter/setter for the number of long non coding genes on alternate sequences
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_alt_mnoncoding_count | ( | ) |
Arg [1] : (optional) alt miscellaneous non coding count Example :
Description: Getter/setter for the number of miscellaneous non coding genes on alternate sequences
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_alt_pseudogene_count | ( | ) |
Arg [1] : (optional) alt pseudogene count Example :
Description: Getter/setter for the number of pseudogenes on alternate sequences
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_alt_rcoding_count | ( | ) |
Arg [1] : (optional) alt readthrough coding count Example :
Description: Getter/setter for the number of readthrough coding genes on alternate sequences
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_alt_rlnoncoding_count | ( | ) |
Arg [1] : (optional) alt readthrough long non coding count Example :
Description: Getter/setter for the number of readthrough long non coding genes on alternate sequences
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_alt_rmnoncoding_count | ( | ) |
Arg [1] : (optional) alt readthrough miscellaneous non coding count Example :
Description: Getter/setter for the number of readthrough miscellaneous non coding genes on alternate sequences
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_alt_rpseudogene_count | ( | ) |
Arg [1] : (optional) alt readthrough pseudogene count Example :
Description: Getter/setter for the number of readthrough pseudogenes on alternate sequences
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_alt_rsnoncoding_count | ( | ) |
Arg [1] : (optional) alt readthrough short non coding count Example :
Description: Getter/setter for the number of readthrough short non coding genes on alternate sequences
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_alt_snoncoding_count | ( | ) |
Arg [1] : (optional) alt short non coding count Example :
Description: Getter/setter for the number of short non coding genes on alternate sequences
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_alt_transcript_count | ( | ) |
Arg [1] : (optional) alt transcript count Example :
Description: Getter/setter for the number of transcripts on alternate sequences in the current build Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public String Bio::EnsEMBL::DBSQL::GenomeContainer::get_assembly_date | ( | ) |
Arg [1] : (optional) assembly date Example :
Description: Getter/setter for the date of the assembly currently used
Returntype : string Exceptions : none Caller : general Status : Stable
Code:
| public String Bio::EnsEMBL::DBSQL::GenomeContainer::get_assembly_name | ( | ) |
Arg [1] : (optional) assembly name Example :
Description: Getter/setter for the name of the assembly currently used
Returntype : string Exceptions : none Caller : general Status : Stable
Code:
| public Bio::EnsEMBL::Attrib Bio::EnsEMBL::DBSQL::GenomeContainer::get_attrib | ( | ) |
Arg [1] : statistic Example :
Description: Returns the attribute object for a given statistic Returntype : Bio::EnsEMBL::Attrib Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_coding_count | ( | ) |
Arg [1] : (optional) coding count Example :
Description: Getter/setter for the number of coding genes in the current build
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public ListRef Bio::EnsEMBL::DBSQL::GenomeContainer::get_coord_systems | ( | ) |
Arg [1] : none Example :
Description: Returns the coord_systems for the assembly currently used
Returntype : ListRef of Bio::EnsEMBL::CoordSystem Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_count | ( | ) |
Arg [1] : none Example :
Description: Retrieve a count for a given attribute code Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public String Bio::EnsEMBL::DBSQL::GenomeContainer::get_genebuild_initial_release_date | ( | ) |
Arg [1] : (optional) genebuild initial release date Example :
Description: Getter/setter for the initial release date of the genebuild currently used
Returntype : string Exceptions : none Caller : general Status : Stable
Code:
| public String Bio::EnsEMBL::DBSQL::GenomeContainer::get_genebuild_last_geneset_update | ( | ) |
Arg [1] : (optional) genebuild last geneset update Example :
Description: Getter/setter for the last geneset update of the genebuild currently used
Returntype : string Exceptions : none Caller : general Status : Stable
Code:
| public String Bio::EnsEMBL::DBSQL::GenomeContainer::get_genebuild_method | ( | ) |
Arg [1] : (optional) genebuild start date Example :
Description: Getter/setter for the method of the genebuild currently used
Returntype : string Exceptions : none Caller : general Status : Stable
Code:
| public String Bio::EnsEMBL::DBSQL::GenomeContainer::get_genebuild_start_date | ( | ) |
Arg [1] : (optional) genebuild start date Example :
Description: Getter/setter for the start date of the genebuild currently used
Returntype : string Exceptions : none Caller : general Status : Stable
Code:
| public Arrayref Bio::EnsEMBL::DBSQL::GenomeContainer::get_genome_components | ( | ) |
Arg : None Example :
Description: Returns the list of (diploid) components, for a
polyploid genome
Returntype : Arrayref
Exceptions : none
Caller : general
Status : Stable
Code:
| public ListRef Bio::EnsEMBL::DBSQL::GenomeContainer::get_karyotype | ( | ) |
Arg [1] : none Example :
Description: Returns the karyotype for the assembly currently used
Returntype : ListRef of Bio::EnsEMBL::Slice Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_lnoncoding_count | ( | ) |
Arg [1] : (optional) long non coding count Example :
Description: Getter/setter for the number of long non coding genes in the current build
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_mnoncoding_count | ( | ) |
Arg [1] : (optional) miscellaneous non coding count Example :
Description: Getter/setter for the number of miscellaneous non coding genes in the current build
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_prediction_count | ( | ) |
Arg [1] : (optional) logic_name Example :
Description: Getter for the number of predicted genes in the current build
Can be restricted to a given analysisReturntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_pseudogene_count | ( | ) |
Arg [1] : (optional) pseudogene count Example :
Description: Getter/setter for the number of pseudogenes in the current build
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_rcoding_count | ( | ) |
Arg [1] : (optional) readthrough coding count Example :
Description: Getter/setter for the number of readthrough coding genes in the current build
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_ref_length | ( | ) |
Arg [1] : (optional) golden path length Example :
Description: Getter/setter for the golden path of the assembly currently used Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_rlnoncoding_count | ( | ) |
Arg [1] : (optional) readthrough long non coding count Example :
Description: Getter/setter for the number of readthrough long non coding genes in the current build
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_rmnoncoding_count | ( | ) |
Arg [1] : (optional) readthrough miscellaneous non coding count Example :
Description: Getter/setter for the number of readthrough miscellaneous non coding genes in the current build
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_rpseudogene_count | ( | ) |
Arg [1] : (optional) readthrough pseudogene count Example :
Description: Getter/setter for the number of readthrough pseudogenes in the current build
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_rsnoncoding_count | ( | ) |
Arg [1] : (optional) readthrough short non coding count Example :
Description: Getter/setter for the number of readthrough short non coding genes in the current build
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_short_variation_count | ( | ) |
Arg [1] : (optional) short variation count Example :
Description: Getter/setter for the number of short variants in the current build
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_snoncoding_count | ( | ) |
Arg [1] : (optional) short non coding count Example :
Description: Getter/setter for the number of short non coding genes in the current build
Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_structural_variation_count | ( | ) |
Arg [1] : none Example :
Description: Return the number of structural variations in the current build Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public ListRef Bio::EnsEMBL::DBSQL::GenomeContainer::get_toplevel | ( | ) |
Arg [1] : none Example :
Description: Returns the toplevel for the assembly currently used
Returntype : ListRef of Bio::EnsEMBL::Slice Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::get_transcript_count | ( | ) |
Arg [1] : (optional) transcript count Example :
Description: Getter/setter for the number of transcripts in the current build Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public String Bio::EnsEMBL::DBSQL::GenomeContainer::get_version | ( | ) |
Arg [1] : (optional) assembly version Example :
Description: Getter/Setter for the assembly version
Returntype : string Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::has_karyotype | ( | ) |
Arg : None Example :
Description: Boolean indicating whether a genome has a karyotype (ie chromosomes)
or not
Returntype : integer
Exceptions : none
Caller : general
Status : Stable
Code:
| public Boolean Bio::EnsEMBL::DBSQL::GenomeContainer::is_empty | ( | ) |
Arg [1] : none Example :
Description: Boolean to check if there is data in the genome container Returntype : Boolean Exceptions : none Caller : general Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::is_high_coverage | ( | ) |
Arg : None Example :
Description: Boolean indicating whether an assembly is high coverage
or not
Returntype : integer
Exceptions : none
Caller : general
Status : Stable
Code:
| public Int Bio::EnsEMBL::DBSQL::GenomeContainer::is_polyploid | ( | ) |
Arg : None Example :
Description: Returns whether the genome is or is not polyploid. Returntype : integer Exceptions : none Caller : general Status : Stable
Code:
| public Bio::EnsEMBL::GenomeContainer Bio::EnsEMBL::DBSQL::GenomeContainer::new | ( | ) |
Arg [...] : Superclass args. See Bio::EnsEMBL::DBSQL::BaseAdaptor Description: Instantiates a Bio::EnsEMBL::DBSQL::GenomeContainer Returntype : Bio::EnsEMBL::GenomeContainer Exceptions : none Caller : DBAdaptor Status : Stable
Code:
| public The Bio::EnsEMBL::DBSQL::GenomeContainer::store | ( | ) |
Arg [1] : Statistic
The type of statistic to store
Arg [2] : Value
The corresponding value for the statistic
Arg [3] : (optional) Attribute
If more than one value exists for the statistics, it will be distinguished by its attribute
Example :Description: Stores a genome statistic in the database Returntype : The database identifier (dbID) of the newly stored genome statistic Exceptions : Caller : general Status : Stable
Code:
| public void Bio::EnsEMBL::DBSQL::GenomeContainer::update | ( | ) |
Arg [1] : Statistic
The type of statistic to update
Arg [2] : Value
The corresponding value for the statistic
Arg [3] : (optional) Attribute
If more than one value exists for the statistics, it will be distinguished by its attribute
Example :Description: Updates an existing genome statistic in the database Returntype : none Exceptions : Caller : general Status : Stable
Code: