Bio::Phenotype::OMIM
MiniMIMentry
Toolbar
Summary
Bio::Phenotype::OMIM::MiniMIMentry - Representation of a Mini MIM entry
Package variables
No package variables defined.
Inherit
Synopsis
use Bio::Phenotype::OMIM::MiniMIMentry;
$mm = Bio::Phenotype::OMIM::MiniMIMentry->new( -description => "The central form of ...",
-created => "Victor A. McKusick: 6/4/1986",
-contributors => "Kelly A. Przylepa - revised: 03/18/2002",
-edited => "alopez: 06/03/1997" );
Description
This class representats of Mini MIM entries.
This class is intended to be used together with a OMIM entry class.
Methods
Methods description
Title : new
Usage : $mm = Bio::Phenotype::OMIM::MiniMIMentry->new( -description => "The central form of ...",
-created => "Victor A. McKusick: 6/4/1986",
-contributors => "Kelly A. Przylepa - revised: 03/18/2002",
-edited => "alopez: 06/03/1997" );
Function: Creates a new MiniMIMentry object.
Returns : A new MiniMIMentry object.
Args : -description => a description
-created => name(s) and date(s) (free form)
-contributors => name(s) and date(s) (free form)
-edited => name(s) and date(s) (free form) |
Title : init()
Usage : $mm->init();
Function: Initializes this MiniMIMentry to all "".
Returns :
Args : |
Title : description
Usage : $mm->description( "The central form of ..." );
or
print $mm->description();
Function: Set/get for the description field of the Mini MIM database.
Returns : The description.
Args : The description (optional). |
Title : created
Usage : $mm->created( "Victor A. McKusick: 6/4/1986" );
or
print $mm->created();
Function: Set/get for the created field of the Mini MIM database.
Returns : Name(s) and date(s) [scalar - free form].
Args : Name(s) and date(s) [scalar - free form] (optional). |
Title : contributors
Usage : $mm->contributors( "Kelly A. Przylepa - revised: 03/18/2002" );
or
print $mm->contributors();
Function: Set/get for the contributors field of the Mini MIM database.
Returns : Name(s) and date(s) [scalar - free form].
Args : Name(s) and date(s) [scalar - free form] (optional). |
Title : edited
Usage : $mm->edited( "alopez: 06/03/1997" );
or
print $mm->edited();
Function: Set/get for the edited field of the Mini MIM database.
Returns : Name(s) and date(s) [scalar - free form].
Args : Name(s) and date(s) [scalar - free form] (optional). |
Title : to_string()
Usage : print $mm->to_string();
Function: To string method for MiniMIMentry objects.
Returns : A string representations of this MiniMIMentry.
Args : |
Methods code
sub new
{
my( $class, @args ) = @_;
my $self = $class->SUPER::new( @args );
my ( $desc, $created, $contributors, $edited )
= $self->_rearrange( [ qw( DESCRIPTION
CREATED
CONTRIBUTORS
EDITED ) ], @args );
$self->init();
$desc && $self->description( $desc );
$created && $self->created( $created );
$contributors && $self->contributors( $contributors );
$edited && $self->edited( $edited );
return $self;
}
} | sub init
{
my( $self ) = @_;
$self->description( "" );
$self->created( "" );
$self->contributors( "" );
$self->edited( "" );
}
} | sub description
{ my ( $self, $value ) = @_;
if ( defined $value ) {
$self->{ "_description" } = $value;
}
return $self->{ "_description" };
}
} | sub created
{ my ( $self, $value ) = @_;
if ( defined $value ) {
$self->{ "_created" } = $value;
}
return $self->{ "_created" };
}
} | sub contributors
{ my ( $self, $value ) = @_;
if ( defined $value ) {
$self->{ "_contributors" } = $value;
}
return $self->{ "_contributors" };
}
} | sub edited
{ my ( $self, $value ) = @_;
if ( defined $value ) {
$self->{ "_edited" } = $value;
}
return $self->{ "_edited" };
}
} | sub to_string
{ my ( $self ) = @_;
my $s = "";
$s .= "-- Description:\n";
$s .= $self->description()."\n";
$s .= "-- Created:\n";
$s .= $self->created()."\n";
$s .= "-- Contributors:\n";
$s .= $self->contributors()."\n";
$s .= "-- Edited:\n";
$s .= $self->edited();
return $s;
}
1;} | General documentation
User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to one
of the Bioperl mailing lists. Your participation is much appreciated.
bioperl-l@bioperl.org - General discussion
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
Please direct usage questions or support issues to the mailing list:
bioperl-l@bioperl.org
rather than to the module maintainer directly. Many experienced and
reponsive experts will be able look at the problem and quickly
address it. Please include a thorough description of the problem
with code and data examples if at all possible.
Report bugs to the Bioperl bug tracking system to help us keep track
the bugs and their resolution. Bug reports can be submitted via the
web:
https://redmine.open-bio.org/projects/bioperl/
The rest of the documentation details each of the object
methods.