LICENSE

Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute Copyright [2016-2024] EMBL-European Bioinformatics Institute

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

            

              
              
http://www.apache.org/licenses/LICENSE-2.0
            
          

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

CONTACT

            

              
              
Please email comments or questions to the public Ensembl
developers list at <http://lists.ensembl.org/mailman/listinfo/dev>.
Questions may also be sent to the Ensembl help desk at
<http://www.ensembl.org/Help/Contact>.
            
          

NAME

Bio::EnsEMBL::Genome - A generic Genome class.

SYNOPSIS

            

              
              
use Bio::EnsEMBL::Genome;
my $genome = Bio::EnsEMBL::Genome->new
     (-NAME => 'myName',
      -CODE => 'MyCode',
      -DESCRIPTION => 'This is my statistics description.',
      -VALUE => '10023');
print $statistic->name(), "\n";
print $statistic->code(), "\n";
print $statistic->description(), "\n";
print $statistic->value(), "\n";
            
          

DESCRIPTION

This is a generic genome class used to represent statistics associated with a genome and species

SEE ALSO

Bio::EnsEMBL::DBSQL::GenomeContainer

new

            

              
              
Arg [-NAME]        : string - the name for this statistic
Arg [-CODE]        : string - the code for this statistic
Arg [-DESCRIPTION] : string - a description for this statistic
Arg [-VALUE]       : value  - the value of this statistic
Example            :   my $genome = Bio::EnsEMBL::Genome->new
                       (-name => 'myName',
                        -CODE => 'MyCode',
                        -DESCRIPTION => 'This is my statistics description.',
                        -VALUE => '10023');  
Description        : Constructor.  Instantiates a Bio::EnsEMBL::Genome object.
Returntype         : Bio::EnsEMBL::Genome
Exceptions         : none
Caller             : general
Status             : Stable
            
          

new_fast

            

              
              
Arg [1]    : hashref to be blessed
Description: Construct a new Bio::EnsEMBL::Genome using the hashref.
Exceptions : none
Returntype : Bio::EnsEMBL::Genome
Caller     : general, subclass constructors
Status     : Stable
            
          

statistic

            

              
              
Arg [1]    : string $statistic (optional)
Example    : $statistic = $statistic->name();
Description: Getter/Setter for the statistic name
Returntype : string
Exceptions : none
Caller     : general
Status     : Stable
            
          

code

            

              
              
Arg [1]    : string $code (optional)
Example    : $code = $genome->code();
Description: Getter/Setter for code statistic
Returntype : string
Exceptions : none
Caller     : general
Status     : Stable
            
          

name

            

              
              
Arg [1]    : string $name (optional)
Example    : $name = $statistic->name();
Description: Getter/Setter for the name associated to the statistic attribute
Returntype : string
Exceptions : none
Caller     : general
Status     : Stable
            
          

description

            

              
              
Arg [1]    : string $description (optional)
Example    : $description = $statistic->description();
Description: Getter/Setter for description statistic
Returntype : string
Exceptions : none
Caller     : general
Status     : Stable
            
          

value

            

              
              
Arg [1]    : string $value (optional)
Example    : $value = $statistic->value();
Description: Getter/Setter for value statistic
Returntype : string
Exceptions : none
Caller     : general
Status     : Stable
            
          

dbID

            

              
              
Arg [1]    : string $value (optional)
Example    : $dbID = $statistic->dbID();
Description: Getter/Setter for statistic internal id
Returntype : string
Exceptions : none
Caller     : general
Status     : Stable
            
          

species_id

            

              
              
Arg [1]    : string $value (optional)
Example    : $species_id = $statistic->dbID();
Description: Getter/Setter for statistic species id
Returntype : string
Exceptions : none
Caller     : general
Status     : Stable
            
          

cpanm Bio::EnsEMBL

perl -MCPAN -e shell
install Bio::EnsEMBL