Bio::PopGen::IO
csv
Summary
Bio::PopGen::IO::csv -Extract individual allele data from a CSV parser
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 = new Bio::PopGen::IO(-format => 'csv',
-file => 'data.csv');
# Some IO might support reading in a population at a time
my @population;
while( my $ind = $io->next_individual ) {
push @population, $ind;
}
Description
This object will parse comma delimited format (CSV) or whatever
delimiter you specify. It currently doesn't handle the more complex
quote escaped CSV format. There are 3 initialization parameters,
the delimiter (-field_delimiter) [default ','], (-allele_delimiter)
[default ' ']. The third initialization parameter is a boolean
-no_header which specifies if there is no header line to read in. All lines starting with '#' will be skipped
When no_header is not specific the data is assumed to be of the following form.
Having a header line this
SAMPLE,MARKERNAME1,MARKERNAME2,...
and each data line having the form (diploid data)
SAMP1,101 102,100 90,a b
or for haploid data
SAMP1,101,100,a
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 : Bio::PopGen::IndividualI object Args : none |
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 |
Title : write_individual Usage : $popgenio->write_individual($ind); Function: Write an individual out in the file format Returns : none Args : Bio::PopGen::PopulationI object(s) |
Title : write_population Usage : $popgenio->write_population($pop); Function: Write a population out in the file format Returns : none Args : Bio::PopGen::PopulationI object(s) Note : Many implementation will not implement this |
Methods code
sub _initialize
{ my($self, @args) = @_;
my ($fieldsep,$all_sep,
$noheader) = $self->_rearrange([qw(FIELD_DELIMITER
ALLELE_DELIMITER
NO_HEADER)],@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->{'_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 next_individual
{ my ($self) = @_;
while( defined( $_ = $self->_readline) ) {
next if( /^\s*\#/ || /^\s+$/ || ! length($_) );
last;
}
return if ! defined $_;
if( $self->flag('no_header') ||
defined $self->{'_header'} ) {
my ($samp,@marker_results);
if($self->flag('field_delimiter') ne $self->flag('allele_delimiter')){
($samp,@marker_results) = split($self->flag('field_delimiter'),$_);
}
else{
my $fielddelim = $self->flag('field_delimiter');
my $alleledelim = $self->flag('allele_delimiter');
($samp) = /(^.+?)$fielddelim/;
s/^.+?$fielddelim//;
(@marker_results) = /([\d|\w]+$alleledelim[\d|\w]+)/g;
}
my $i = 1;
foreach my $m ( @marker_results ) {
$m =~ s/^\s+//;
$m =~ s/\s+$//;
my $markername;
if( defined $self->{'_header'} ) {
$markername = $self->{'_header'}->[$i];
} else {
$markername = "Marker$i";
}
$self->debug( "markername is $markername alleles are $m\n");
my @alleles = split($self->flag('allele_delimiter'), $m);
$m = new Bio::PopGen::Genotype(-alleles =>\@ alleles,
-marker_name => $markername,
-individual_id=> $samp);
$i++;
}
return new Bio::PopGen::Individual(-unique_id => $samp,
-genotypes =>\@ marker_results);
} else {
chomp;
$self->{'_header'} = [split($self->flag('field_delimiter'),$_)];
return $self->next_individual; }
return;} |
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) = @_;
my $fielddelim = $self->flag('field_delimiter');
my $alleledelim= $self->flag('allele_delimiter');
foreach my $ind ( @inds ) {
if (! ref($ind) || ! $ind->isa('Bio::PopGen::IndividualI') ) {
$self->warn("Cannot write an object that is not a Bio::PopGen::IndividualI object ($ind)");
next;
}
my @marker_names = sort $ind->get_marker_names;
if( ! $self->flag('no_header') &&
! $self->flag('header_written') ) {
$self->_print(join($fielddelim, ('SAMPLE', @marker_names)), "\n");
$self->flag('header_written',1);
}
$self->_print( join($fielddelim, $ind->unique_id,
map { join($alleledelim,$_->get_Alleles) }
map {$ind->get_Genotypes(-marker => $_)}
@marker_names), "\n")
}} |
sub write_population
{ my ($self,@pops) = @_;
my $fielddelim = $self->flag('field_delimiter');
my $alleledelim = ' ';
foreach my $pop ( @pops ) {
if (! ref($pop) || ! $pop->isa('Bio::PopGen::PopulationI') ) {
$self->warn("Cannot write an object that is not a Bio::PopGen::PopulationI object");
next;
}
my @marker_names = sort $pop->get_marker_names;
if( ! $self->flag('no_header') &&
! $self->flag('header_written') ) {
$self->_print( join($fielddelim, ('SAMPLE', @marker_names)),
"\n");
$self->flag('header_written',1);
}
foreach my $ind ( $pop->get_Individuals ) {
$self->_print( join($fielddelim, $ind->unique_id,
map { join($alleledelim,$_->get_Alleles) }
map {$ind->get_Genotypes(-marker => $_)}
@marker_names), "\n");
}
}} |
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
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:
http://bugzilla.open-bio.org/
| AUTHOR - Jason Stajich | Top |
Email jason-at-bioperl.org
Matthew Hahn, matthew.hahn-at-duke.edu
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _
Title : new
Usage : my $obj = new Bio::PopGen::IO::csv();
Function: Builds a new Bio::PopGen::IO::csv object
Returns : an instance of Bio::PopGen::IO::csv
Args : [optional, these are the current defaults]
-field_delimiter => ','
-allele_delimiter=> '\s+'
-no_header => 0,