Bio::EnsEMBL::Funcgen ExperimentalSubset
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvsRaw content
Summary
Bio::EnsEMBL::ExperimentalSet - A module to represent ExperimentalSubset object.
Package variables
No package variables defined.
Included modules
Bio::EnsEMBL::Funcgen::Storable
Bio::EnsEMBL::Utils::Argument qw ( rearrange )
Bio::EnsEMBL::Utils::Exception qw ( throw )
Inherit
Bio::EnsEMBL::Funcgen::Storable
Synopsis
use Bio::EnsEMBL::Funcgen::ExperimetnalSubset;
my $data_set = Bio::EnsEMBL::Funcgen::ExperimentalSubset->new(
-DBID => $dbID,
-ADAPTOR => $self,
-NAME => $name,
-EXPERIMENTAL_SET => $eset,
);
Description
An ExperimentalSubset object is a very simple skeleton class to enable storage of associated subset states. As such there
are only very simple accessor methods for basic information, and there is no namesake adaptor, rather is is handled by the
ExperimentalSetAdaptor.
Methods
experimental_setDescriptionCode
nameDescriptionCode
newDescriptionCode
Methods description
experimental_setcode    nextTop
  Example    : my $eset = $exp_sset->experimental_set();
  Description: Getter for the experimental_set attribute of this ExperimentalSubset.
  Returntype : Bio::EnsEMBL::Funcgen::ExperimentalSet
  Exceptions : None
  Caller     : General
  Status     : At Risk
namecodeprevnextTop
  Example    : my $name = $exp_sset->name();
  Description: Getter for the name of this ExperimentalSubset.
  Returntype : string
  Exceptions : None
  Caller     : General
  Status     : At Risk
newcodeprevnextTop
  Example    : my $eset = Bio::EnsEMBL::Funcgen::ExperimentalSubset->new(
                                                                        -DBID            => $dbID,
							 					                        -ADAPTOR         => $self,
                                                                        -NAME            => $name,
                                                                        -EXPERIMENTAL_SET => $eset,
                                                                        );

  Description: Constructor for ExperimentalSubset objects.
  Returntype : Bio::EnsEMBL::Funcgen::ExperimentalSubset
  Exceptions : Throws if no name defined
               Throws if CellType or FeatureType are not valid or stored
  Caller     : General
  Status     : At risk
Methods code
experimental_setdescriptionprevnextTop
sub experimental_set {
  my $self = shift;
  return $self->{'experimental_set'};
}



1;
}
namedescriptionprevnextTop
sub name {
  my $self = shift;
  return $self->{'name'};
}
newdescriptionprevnextTop
sub new {
  my $caller = shift;
	
  my $class = ref($caller) || $caller;
	
  my $self = $class->SUPER::new(@_);
	
  #do we need to add $fg_ids to this?  Currently maintaining one feature_group focus.(combi exps?)
  my ($name, $eset)
    = rearrange(['NAME', 'EXPERIMENTAL_SET'], @_);
  
  
  throw('Must provide a name argument') if ! defined $name;

  if(!(ref($eset) && 
	   $eset->isa('Bio::EnsEMBL::Funcgen::ExperimentalSet')
	   && $eset->dbID())){
	throw('Must provide a valid stored experimental_set argument');
  }
  

  $self->{'name'} = $name;
  $self->{'experimental_set'} = $eset;

  return $self;
}
General documentation
AUTHORTop
This module was created by Nathan Johnson.
This module is part of the Ensembl project: /
CONTACTTop
Post comments or questions to the Ensembl development list: ensembl-dev@ebi.ac.uk