/usr/share/perl5/Bio/Tools/Run/Phylo/Hyphy/Modeltest.pm is in libbio-perl-run-perl 1.7.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 | # $Id$
#
# BioPerl module for Bio::Tools::Run::Phylo::Hyphy::Modeltest
#
# Please direct questions and support issues to <bioperl-l@bioperl.org>
#
# Cared for by Albert Vilella <avilella-at-gmail-dot-com>
#
# Copyright Albert Vilella
#
# You may distribute this module under the same terms as perl itself
# POD documentation - main docs before the code
=head1 NAME
Bio::Tools::Run::Phylo::Hyphy::Modeltest - Wrapper around the Hyphy Modeltest analysis
=head1 SYNOPSIS
use Bio::Tools::Run::Phylo::Hyphy::Modeltest;
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 $modeltest = Bio::Tools::Run::Phylo::Hyphy::Modeltest->new();
$modeltest->alignment($aln);
$modeltest->tree($tree);
my ($rc,$results) = $modeltest->run();
=head1 DESCRIPTION
This is a wrapper around the Modeltest 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/Modeltest.bf.
=head1 FEEDBACK
=head2 Mailing Lists
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
=head2 Support
Please direct usage questions or support issues to the mailing list:
I<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.
=head2 Reporting Bugs
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://redmine.open-bio.org/projects/bioperl/
=head1 AUTHOR - Albert Vilella
Email avilella-at-gmail-dot-com
=head1 CONTRIBUTORS
Additional contributors names and emails here
=head1 APPENDIX
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _
=cut
# Let the code begin...
package Bio::Tools::Run::Phylo::Hyphy::Modeltest;
use vars qw(@ISA);
use strict;
use Bio::Root::Root;
use Bio::AlignIO;
use Bio::TreeIO;
use Bio::Tools::Run::Phylo::Hyphy::Base;
use Bio::Tools::Run::WrapperBase;
use base qw(Bio::Root::Root Bio::Tools::Run::Phylo::Hyphy::Base);
=head2 Default Values
Valid and default values for Modeltest 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.
=cut
=head2 valid_values
Title : valid_values
Usage : $factory->valid_values()
Function: returns the possible parameters
Returns: an array holding all possible parameters. The default
values are always the first one listed. These descriptions are
essentially lifted from the python wrapper or provided by the author.
Args : None
=cut
sub valid_values {
return
(
{'tempalnfile' => undef }, # aln file goes here
{'temptreefile' => undef }, # tree file goes here
{'Number of Rate Classes' => [ '4' ] },
{'Model Selection Method' => [ 'Both',
'Hierarchical Test',
'AIC Test'] },
{'Model rejection level' => '0.05' },
{'hieoutfile' => undef },
{'aicoutfile' => undef }
);
}
=head2 new
Title : new
Usage : my $obj = Bio::Tools::Run::Phylo::Hyphy::Modeltest->new();
Function: Builds a new Bio::Tools::Run::Phylo::Hyphy::Modeltest object
Returns : Bio::Tools::Run::Phylo::Hyphy::Modeltest
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: L<Bio::Tree::TreeI>, L<Bio::Align::AlignI>
=cut
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;
}
=head2 run
Title : run
Usage : my ($rc,$results) = $modeltest->run($aln);
Function: run the modeltest analysis using the default or updated parameters
the alignment parameter must have been set
Returns : Return code, hash containing the "Hierarchical Testing" and "AIC" results, both as hashes.
Args : L<Bio::Align::AlignI> object,
L<Bio::Tree::TreeI> object [optional]
=cut
sub run {
my $self = shift;
my ($rc, $run_results) = $self->SUPER::run();
my $results = {};
my @run_result_array = split (/\n/, $run_results);
my $line = shift @run_result_array;
my $current_model = "error"; # if this stays "error" when you're trying to add results for a model, something's wrong.
while (defined $line) {
if ($line =~ m/Hierarchical Testing based model \((.*)\)/) {
$current_model = "Hierarchical Testing";
$results->{$current_model}{'model_name'} = $1;
} elsif ($line =~ m/AIC based model \((.*)\)/) {
$current_model = "AIC";
$results->{$current_model}{'model_name'} = $1;
} elsif ($line =~ m/Model String:(\d+)/) {
$results->{$current_model}{'model_string'} = $1;
} elsif ($line =~ m/Model Options: (.+)/) {
$results->{$current_model}{'model_options'} = $1;
} elsif ($line =~ m/Equilibrium Frequencies Option: (.+)/) {
$results->{$current_model}{'eq_freq_option'} = $1;
}
$line = shift @run_result_array;
}
return ($rc,$results);
}
=head2 create_wrapper
Title : create_wrapper
Usage : $self->create_wrapper
Function: It will create the wrapper file that interfaces with the analysis bf file
Example :
Returns :
Args :
=cut
sub create_wrapper {
my $self = shift;
my $batchfile = "/usr/share/hyphy/TemplateBatchFiles/ModelTest.bf";
$self->SUPER::create_wrapper($batchfile);
}
1;
|