Bio::Tools::Run::Phylo::Hyphy
FEL
Toolbar
Summary
Bio::Tools::Run::Phylo::Hyphy::FEL - Wrapper around the Hyphy FEL analysis
Package variables
No package variables defined.
Included modules
Bio::AlignIO
Bio::Root::Root
Bio::Tools::Run::WrapperBase
Bio::TreeIO
Inherit
Synopsis
use Bio::Tools::Run::Phylo::Hyphy::FEL;
use Bio::AlignIO;
use Bio::TreeIO;
my $alignio = Bio::AlignIO->new(-format => 'fasta',
-file => 't/data/hyphy1.fasta');
my $aln = $alignio->next_aln;
my $treeio = Bio::TreeIO->new(
-format => 'newick', -file => 't/data/hyphy1.tree');
my $fel = Bio::Tools::Run::Phylo::Hyphy::FEL->new();
$fel->alignment($aln);
$fel->tree($tree);
my ($rc,$results) = $fel->run();
Description
This is a wrapper around the FEL analysis of HyPhy ([Hy]pothesis
Testing Using [Phy]logenies) package of Sergei Kosakowsky Pond,
Spencer V. Muse, Simon D.W. Frost and Art Poon. See
http://www.hyphy.org for more information.
This module will generate the correct list of options for interfacing
with TemplateBatchFiles/Ghostrides/Wrapper.bf.
Methods
Methods description
Title : new Usage : my $obj = Bio::Tools::Run::Phylo::Hyphy::FEL->new(); Function: Builds a new Bio::Tools::Run::Phylo::Hyphy::FEL object Returns : Bio::Tools::Run::Phylo::Hyphy::FEL Args : -alignment => the Bio::Align::AlignI object -save_tempfiles => boolean to save the generated tempfiles and NOT cleanup after onesself (default FALSE) -tree => the Bio::Tree::TreeI object -params => a hashref of parameters (all passed to set_parameter) -executable => where the hyphy executable resides
See also: Bio::Tree::TreeI, Bio::Align::AlignI |
Title : run Usage : my ($rc,$results) = $fel->run($aln); Function: run the fel analysis using the default or updated parameters the alignment parameter must have been set Returns : Return code, Hash Args : Bio::Align::AlignI object, Bio::Tree::TreeI object [optional] |
Title : create_wrapper Usage : $self->create_wrapper Function: It will create the wrapper file that interfaces with the analysis bf file Example : Returns : Args : |
Title : set_default_parameters Usage : $fel->set_default_parameters(0); Function: (Re)set the default parameters from the defaults (the first value in each array in the %VALIDVALUES class variable) Returns : none Args : boolean: keep existing parameter values |
Methods code
BEGIN { @VALIDVALUES =
(
{'geneticCode' => [ "Universal","VertebratemtDNA","YeastmtDNA","Mold/ProtozoanmtDNA",
"InvertebratemtDNA","CiliateNuclear","EchinodermmtDNA","EuplotidNuclear",
"Alt.YeastNuclear","AscidianmtDNA","FlatwormmtDNA","BlepharismaNuclear"]},
{'New/Restore' => [ "New Analysis", "Restore"]},
{'tempalnfile' => undef }, {'Model Options' => [ { "Custom" => '010010' },
{ "Default" => undef } ]
},
{'temptreefile' => undef }, {'Model Fit Results' => [ '/dev/null'] }, {'dN/dS bias parameter' => [ { "Estimate dN/dS only" => undef },
{ "Neutral" => undef },
{ "Estimate" => undef },
{ "Estimate + CI" => undef },
{ "User" => '3' } ] },
{'Ancestor Counting' => [ 'Two rate FEL','Single Ancestor Counting','Weighted Ancestor Counting',
'Sample Ancestal States','Process Sampled Ancestal States',
'One rate FEL','Rate Distribution',
'Full site-by-site LRT','Multirate FEL'] },
{'Significance level' => '0.05' },
{'Branch Options' => ['Internal Only','All','A Subtree only','Custom subset'] },
{'outfile' => undef }, );} |
sub new
{ my($class,@args) = @_;
my $self = $class->SUPER::new(@args);
my ($aln, $tree, $st, $params, $exe,
$ubl) = $self->_rearrange([qw(ALIGNMENT TREE SAVE_TEMPFILES
PARAMS EXECUTABLE)],
@args);
defined $aln && $self->alignment($aln);
defined $tree && $self->tree($tree);
defined $st && $self->save_tempfiles($st);
defined $exe && $self->executable($exe);
$self->set_default_parameters();
if( defined $params ) {
if( ref($params) !~ /HASH/i ) {
$self->warn("Must provide a valid hash ref for parameter -FLAGS");
} else {
map { $self->set_parameter($_, $$params{$_}) } keys %$params;
}
}
return $self;} |
sub run
{ my ($self,$aln,$tree) = @_;
$self->prepare($aln,$tree) unless (defined($self->{'_prepared'}));
my ($rc,$results) = (1);
{
my $commandstring;
my $exit_status;
my $tempdir = $self->tempdir;
my $felexe = $self->executable();
$self->throw("unable to find or run executable for 'HYPHY'") unless $felexe && -e $felexe && -x _;
$commandstring = $felexe . " BASEPATH=" . $self->program_dir . " " . $self->{'_wrapper'};
open(RUN, "$commandstring |") or $self->throw("Cannot open exe $felexe");
my @output = <RUN>;
$exit_status = close(RUN);
$self->error_string(join('',@output));
if( (grep { /\berr(or)?: /io } @output) || !$exit_status) {
$self->warn("There was an error - see error_string for the program output");
$rc = 0;
}
my $outfile = $self->outfile_name;
eval {
open(OUTFILE, "$outfile") or $self->throw("cannot open $outfile for reading");
my $readed_header = 0;
my @elems;
while (<OUTFILE>) {
if ($readed_header) {
my @values = split("\,",$_);
for my $i (0 .. (scalar(@values)-1)) {
$elems[$i] =~ s/\n//g;
push @{$results->{$elems[$i]}}, $values[$i];
}
} else {
@elems = split("\,",$_);
$readed_header = 1;
}
}
};
if( $@ ) {
$self->warn($self->error_string);
}
}
unless ( $self->save_tempfiles ) {
unlink($self->{'_wrapper'});
$self->cleanup();
}
return ($rc,$results);} |
sub create_wrapper
{ my $self = shift;
my $batchfile = 'QuickSelectionDetection.bf';
$self->SUPER::create_wrapper($batchfile); } |
sub set_default_parameters
{ my ($self,$keepold) = @_;
$keepold = 0 unless defined $keepold;
foreach my $elem (@VALIDVALUES) {
my ($param,$val) = each %$elem;
if (ref($val)=~/ARRAY/i ) {
unless (ref($val->[0])=~/HASH/i) {
push @{ $self->{'_orderedparams'} }, {$param, $val->[0]};
} else {
$val = $val->[0];
}
}
if ( ref($val) =~ /HASH/i ) {
my $prevparam;
while (defined($val)) {
last unless (ref($val) =~ /HASH/i);
last unless (defined($param));
$prevparam = $param;
($param,$val) = each %{$val};
push @{ $self->{'_orderedparams'} }, {$prevparam, $param};
push @{ $self->{'_orderedparams'} }, {$param, $val} if (defined($val));
}
} elsif (ref($val) !~ /HASH/i && ref($val) !~ /ARRAY/i) {
push @{ $self->{'_orderedparams'} }, {$param, $val};
}
}} |
sub DESTROY
{ my $self= shift;
unless ( $self->save_tempfiles ) {
$self->cleanup();
}
$self->SUPER::DESTROY();
}
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.
| AUTHOR - Albert Vilella | Top |
Email avilella-at-gmail-dot-com
Additional contributors names and emails here
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _
Valid and default values for FEL are listed below. The default
values are always the first one listed. These descriptions are
essentially lifted from the python wrapper or provided by the author.
INCOMPLETE DOCUMENTATION OF ALL METHODS
Title : program_name
Usage : $factory->program_name()
Function: holds the program name
Returns: string
Args : None
Title : program_dir
Usage : ->program_dir()
Function: returns the program directory, obtained from ENV variable.
Returns: string
Args :
Title : error_string
Usage : $obj->error_string($newval)
Function: Where the output from the last analysus run is stored.
Returns : value of error_string
Args : newvalue (optional)
| Bio::Tools::Run::WrapperBase methods | Top |
Title : no_param_checks
Usage : $obj->no_param_checks($newval)
Function: Boolean flag as to whether or not we should
trust the sanity checks for parameter values
Returns : value of no_param_checks
Args : newvalue (optional)
Title : save_tempfiles
Usage : $obj->save_tempfiles($newval)
Function:
Returns : value of save_tempfiles
Args : newvalue (optional)
Title : tempdir
Usage : my $tmpdir = $self->tempdir();
Function: Retrieve a temporary directory name (which is created)
Returns : string which is the name of the temporary directory
Args : none
Title : cleanup
Usage : $fel->cleanup();
Function: Will cleanup the tempdir directory after a run
Returns : none
Args : none