Bio::PopGen::IO
hapmap
Toolbar
Summary
Bio::PopGen::IO::hapmap - A parser for HapMap output data
Package variables
No package variables defined.
Included modules
Inherit
Synopsis
# Do not use directly, use through the Bio::PopGen::IO driver
use Bio::PopGen::IO;
my $io = Bio::PopGen::IO->new(-format => 'hapmap',
-file => 'data.hapmap');
# Some IO might support reading in a population at a time
my @population;
while( my $ind = $io->next_individual ) {
push @population, $ind;
}
Description
A driver module for Bio::PopGen::IO for parsing hapmap data.
Methods
Methods description
Title : flag Usage : $obj->flag($flagname,$newval) Function: Get/Set the flag value Returns : value of a flag (a boolean) Args : A flag name, currently we expect 'no_header', 'field_delimiter', or 'allele_delimiter' on set, new value (a boolean or undef, optional) |
Title : next_individual Usage : my $ind = $popgenio->next_individual; Function: Retrieve the next individual from a dataset Returns : A Bio::PopGen::IndividualI object Args : none
See Bio::PopGen::IndividualI |
Title : next_population Usage : my $ind = $popgenio->next_population; Function: Retrieve the next population from a dataset Returns : Bio::PopGen::PopulationI object Args : none Note : Many implementation will not implement this
See Bio::PopGen::PopulationI |
Title : write_individual Usage : $popgenio->write_individual($ind); Function: Write an individual out in the file format NOT SUPPORTED BY hapmap format Returns : none Args : Bio::PopGen::PopulationI object(s)
See Bio::PopGen::PopulationI |
Title : write_population Usage : $popgenio->write_population($pop); Function: Write a population out in the file format NOT SUPPORTED BY hapmap format Returns : none Args : Bio::PopGen::PopulationI object(s) Note : Many implementation will not implement this
See Bio::PopGen::PopulationI |
Title : starting_column Usage : $obj->starting_column($newval) Function: Column where data starts Example : Returns : value of starting_column (a scalar) Args : on set, new value (a scalar or undef, optional) |
Methods code
sub _initialize
{
my($self, @args) = @_;
$Bio::PopGen::Genotype::BlankAlleles='';
my ($fieldsep,$all_sep,
$noheader, $start_col) = $self->_rearrange([qw(FIELD_DELIMITER
ALLELE_DELIMITER
NO_HEADER
STARTING_COLUMN)],
@args);
$self->flag('no_header', defined $noheader ? $noheader : $NoHeader);
$self->flag('field_delimiter',defined $fieldsep ? $fieldsep : $FieldDelim);
$self->flag('allele_delimiter',defined $all_sep ? $all_sep : $AlleleDelim);
$self->starting_column(defined $start_col ? $start_col : $StartingCol );
$self->{'_header'} = undef;
return 1;} |
sub flag
{
my $self = shift;
my $fieldname = shift;
return unless defined $fieldname;
return $self->{'_flag'}->{$fieldname} = shift if @_;
return $self->{'_flag'}->{$fieldname};} |
sub _pivot
{ my ($self) = @_;
my (@cols,@rows,@idheader);
while ($_ = $self->_readline){
chomp($_);
next if( /^\s*\#/ || /^\s+$/ || ! length($_) );
if( /^rs\#\s+alleles\s+chrom\s+pos\s+strand/ ) {
@idheader = split $self->flag('field_delimiter');
} else {
push @cols, [split $self->flag('field_delimiter')];
}
}
my $startingcol = $self->starting_column;
$self->{'_header'} = [ map { $_->[0] } @cols];
for my $n ($startingcol.. $#{ $cols[ 0 ]}) {
my $column = [ $idheader[$n],
map{ $_->[ $n ] } @cols ];
push (@rows, $column);
}
$self->{'_pivot'} = [@rows];
$self->{'_i'} = 0;} |
sub next_individual
{ my ($self) = @_;
unless($self->{'_pivot'}){
$self->_pivot;
}
$_ = $self->{'_pivot'}->[$self->{'_i'}++];
return unless defined $_;
my ($samp,@marker_results) = @$_;
my $i = 1;
foreach my $m ( @marker_results ) {
$m =~ s/^\s+//;
$m =~ s/\s+$//;
my $markername;
if( defined $self->{'_header'} ) {
$markername = $self->{'_header'}->[$i-1];
} else {
$markername = "Marker$i";
}
my @alleles = split($self->flag('allele_delimiter'), $m);
if( @alleles != 2 ) {
$self->warn("$m for $samp\n");
} else {
$m = Bio::PopGen::Genotype->new(-alleles =>\@ alleles,
-marker_name => $markername,
-marker_type => 'S', -individual_id => $samp);
}
$i++;
}
return new Bio::PopGen::Individual(-unique_id => $samp,
-genotypes =>\@ marker_results);} |
sub next_population
{ my ($self) = @_;
my @inds;
while( my $ind = $self->next_individual ) {
push @inds, $ind;
}
Bio::PopGen::Population->new(-individuals =>\@ inds);} |
sub write_individual
{ my ($self,@inds) = @_;
$self->throw_not_implemented();} |
sub write_population
{ my ($self,@inds) = @_;
$self->throw_not_implemented();} |
sub starting_column
{ my $self = shift;
return $self->{'starting_column'} = shift if @_;
return $self->{'starting_column'};
}
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
the Bioperl mailing list. 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
of the bugs and their resolution. Bug reports can be submitted via
the web:
https://redmine.open-bio.org/projects/bioperl/
Email r.j.dobson-at-qmul.ac.uk
Jason Stajich, jason-at-bioperl.org
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _
Title : new
Usage : my $obj = Bio::PopGen::IO::hapmap->new();
Function: Builds a new Bio::PopGen::IO::hapmap object
Returns : an instance of Bio::PopGen::IO::hapmap
Args : [optional, these are the current defaults]
-field_delimiter => ','
-allele_delimiter=> '\s+'
-no_header => 0,
-starting_column => 11