/usr/share/perl5/Bio/Factory/EMBOSS.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 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 | # $Id$
#
# BioPerl module for Bio::Factory::EMBOSS
#
# Please direct questions and support issues to <bioperl-l@bioperl.org>
#
# Cared for by Heikki Lehvaslaiho <heikki-at-bioperl-dot-org>
#
# Copyright Heikki Lehvaslaiho
#
# You may distribute this module under the same terms as perl itself
# POD documentation - main docs before the code
=head1 NAME
Bio::Factory::EMBOSS - EMBOSS application factory class
=head1 SYNOPSIS
# get an EMBOSS factory
use Bio::Factory::EMBOSS;
$f = Bio::Factory::EMBOSS -> new();
# get an EMBOSS application object from the factory
$water = $f->program('water') || die "Program not found!\n";
# here is an example of running the application -
# water can compare 1 sequence against 1 or more sequences
# in a database using Smith-Waterman
my $seq_to_test; # this would have a seq here
my @seqs_to_check; # this would be a list of seqs to compare
# (could be just 1)
my $wateroutfile = 'out.water';
$water->run({-sequences => $seq_to_test,
-seqall => \@seqs_to_check,
-gapopen => '10.0',
-gapextend => '0.5',
-outfile => $wateroutfile});
# now you might want to get the alignment
use Bio::AlignIO;
my $alnin = Bio::AlignIO->new(-format => 'emboss',
-file => $wateroutfile);
while ( my $aln = $alnin->next_aln ) {
# process the alignment -- these will be Bio::SimpleAlign objects
}
=head1 DESCRIPTION
The EMBOSS factory class encapsulates access to EMBOSS programs. A
factory object allows creation of only known applications.
If you want to check command line options before sending them to the
program set $prog-E<gt>verbose to positive integer. The value is
passed on to programs objects and the ADC description of the available
command line options is parsed and compared to input.
See also L<Bio::Tools::Run::EMBOSSApplication> and
L<Bio::Tools::Run::EMBOSSacd>.
=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 lists 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
the bugs and their resolution. Bug reports can be submitted via the
web:
http://redmine.open-bio.org/projects/bioperl/
=head1 AUTHOR - Heikki Lehvaslaiho
Email heikki-at-bioperl-dot-org
=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::Factory::EMBOSS;
use vars qw(@ISA $EMBOSSVERSION);
use strict;
use Bio::Root::Root;
use Bio::Tools::Run::EMBOSSApplication;
use Bio::Factory::ApplicationFactoryI;
@ISA = qw(Bio::Root::Root Bio::Factory::ApplicationFactoryI );
$EMBOSSVERSION = "2.0.0";
sub new {
my($class,@args) = @_;
my $self = $class->SUPER::new(@args);
# set up defaults
my($location) = $self->_rearrange([qw(LOCATION )], @args);
$self->{ '_programs' } = {};
$self->{ '_programgroup' } = {};
$self->{ '_groups' } = {};
$self->location($location) if $location;
$self->_program_list; # retrieve info about available programs
return $self;
}
=head2 location
Title : location
Usage : $embossfactory->location
Function: get/set the location of EMBOSS programs.
Valid values are 'local' and 'novella'.
Returns : string, defaults to 'local'
Args : string
=cut
sub location {
my ($self, $value) = @_;
my %location = ('local' => '1',
'novella' => '1'
);
if (defined $value) {
$value = lc $value;
if ($location{$value}) {
$self->{'_location'} = $value;
} else {
$self->warn("Value [$value] not a valid value for ".
"location(). Defaulting to [local]");
$self->{'_location'} = 'local';
}
}
$self->{'_location'} ||= 'local';
return $self->{'_location'};
}
=head2 program
Title : program
Usage : $embossfactory->program('program_name')
Function: Creates a representation of a single EMBOSS program and issues a
warning if the program was not found.
Returns : Bio::Tools::Run::EMBOSSApplication object or undef
Args : string, program name
=cut
sub program {
my ($self, $value) = @_;
unless( $self->{'_programs'}->{$value} ) {
$self->warn("Application [$value] is not available!");
return undef;
}
my $attr = {};
$attr->{name} = $value;
$attr->{verbose} = $self->verbose;
my $appl = Bio::Tools::Run::EMBOSSApplication->new($attr);
return $appl;
}
=head2 version
Title : $self->version
Usage : $embossfactory->version()
Function: gets the version of EMBOSS programs
Throws : if EMBOSS suite is not accessible
Returns : version value
Args : None
=cut
sub version {
my ($self) = @_;
my $version = `embossversion -auto`;
$self->throw("EMBOSS suite of programs is not available") if $?;
chop $version;
# compare versions
$self->throw("EMBOSS has to be at least version $EMBOSSVERSION got $version\n")
if $version lt $EMBOSSVERSION;
return $version;
}
=head2 Programs
These methods allow the programmer to query the EMBOSS suite and find
out which program names can be used and what arguments can be used.
=head2 program_info
Title : program_info
Usage : $embossfactory->program_info('emma')
Function: Finds out if the program is available.
Returns : definition string of the program, undef if program name not known
Args : string, prgramname
=cut
sub program_info {
my ($self, $value) = @_;
return $self->{'_programs'}->{$value};
}
=head2 Internal methods
Do not call these methods directly
=head2 _program_list
Title : _program_list
Usage : $embossfactory->_program_list()
Function: Finds out what programs are available.
Writes the names into an internal hash.
Returns : true if successful
Args : None
=cut
sub _program_list {
my ($self) = @_;
if( $^O =~ /Mac/i ) { return; }
{
my $null = ($^O =~ m/mswin/i) ? 'NUL' : '/dev/null';
local * SAVERR;
open SAVERR, ">&STDERR";
open STDERR, ">$null";
open(WOSSOUT, "wossname -auto |") || return;
open STDERR, ">&SAVERR";
}
local $/ = "\n\n";
while(<WOSSOUT> ) {
my ($groupname) = (/^([A-Z][A-Z0-9 ]+)$/m);
#print $groupname, "\n" if $groupname;
$self->{'_groups'}->{$groupname} = [] if $groupname;
while ( /^([a-z]\w+) +(.+)$/mg ) {
#print "$1\t$2 \n" if $1;
$self->{'_programs'}->{$1} = $2 if $1;
$self->{'_programgroup'}->{$1} = $groupname if $1;
push @{$self->{'_groups'}->{$groupname}}, $1 if $1;
}
}
close(WOSSOUT);
}
1;
|