Bio::Tools::Run
Promoterwise
Toolbar
Summary
Bio::Tools::Run::Promoterwise - Wrapper for aligning two sequences using
promoterwise
Package variables
No package variables defined.
Included modules
Bio::Root::Root
Bio::SeqIO
Bio::Tools::Promoterwise
Bio::Tools::Run::WrapperBase
strict
Inherit
Bio::Root::Root Bio::Tools::Run::WrapperBase
Synopsis
# Build a Promoterwise alignment factory
my @params = ('-s'=>1,'-query_start'=>10,'-dymem'=>1);
my $factory = Bio::Tools::Run::Promoterwise->new(@params);
my (@fp)= $factory->run($seq1,$seq2);
# each feature pair is a group of hsps
foreach my $fp(@fp){
print "Hit Length: ".$fp->feature1->length."\n";
print "Hit Start: ".$fp->feature1->start."\n";
print "Hit End: ".$fp->feature1->end."\n";
print "Hsps: \n";
my @first_hsp = $fp->feature1->sub_SeqFeature;
my @second_hsp = $fp->feature2->sub_SeqFeature;
for ($i..$#first_hsp){
print $first_hsp[$i]->seq." ".$second_hsp[$i]->seq."\n";
}
}
print "end: ". $fp->feature2->start."\t".$fp->feature2->end."\n";
#Available parameters include:
#( S T U V QUERY_START QUERY_END TARGET_START
#TARGET_END LHWINDOW LHSEED LHALN LHSCORE LHREJECT
#LHREJECT LHMAX DYMEM KBYTE DYCACHE)
#For an explanation of these parameters, please see documentation
#from the Wise package.
Description
Promoterwise is an alignment algorithm that relaxes the constraint
that local alignments have to be co-linear. Otherwise it provides a
similar model to DBA, which is designed for promoter sequence
alignments by Ewan Birney. It is part of the wise2 package available
at:
http://www.sanger.ac.uk/software/wise2.
Methods
Methods description
Title : program_name Usage : $factory>program_name() Function: holds the program name Returns: string Args : None |
Title : program_dir Usage : $factory->program_dir(@params) Function: returns the program directory, obtained from ENV variable. Returns: string Args : |
Title : version Usage : exit if $prog->version() < 1.8 Function: Determine the version number of the program Example : Returns : float or undef Args : none |
Title : run Usage : 2 sequence objects @fp = $factory->run($seq1, $seq2); Function: run Returns : An array of <Bio::SeqFeature::FeaturePair> Args : Name of a file containing a set of 2 fasta sequences or else 2 Bio::Seq objects.
Throws an exception if argument is not either a string (eg a filename) or 2 Bio::Seq objects. If arguments are strings, throws exception if file corresponding to string name can not be found. |
Title : _run Usage : Internal function, not to be called directly Function: makes actual system call to a promoterwise program Example : Returns : Bio::SeqFeature::FeaturePair Args : Name of a files containing 2 sequences in the order of peptide and genomic |
Title : _setparams Usage : Internal function, not to be called directly Function: creates a string of params to be used in the command string Example : Returns : string of params Args : |
Methods code
BEGIN { @PROMOTERWISE_PARAMS = qw( S T U V QUERY_START QUERY_END TARGET_START
TARGET_END LHWINDOW LHSEED LHALN LHSCORE LHREJECT
LHREJECT LHMAX DYMEM KBYTE DYCACHE);
@OTHER_SWITCHES = qw(SILENT QUIET ERROROFFSTD);
foreach my $attr ( @PROMOTERWISE_PARAMS, @PROMOTERWISE_SWITCHES,
@OTHER_SWITCHES) { $OK_FIELD{$attr}++;} |
sub program_name
{ return 'promoterwise'; } |
sub program_dir
{ return Bio::Root::IO->catfile($ENV{WISEDIR},"/src/bin/") if $ENV{WISEDIR};} |
sub new
{ my ($class, @args) = @_;
my $self = $class->SUPER::new(@args);
my ($attr, $value);
while (@args) {
$attr = shift @args;
$value = shift @args;
next if( $attr =~ /^-/ ); $self->$attr($value);
}
return $self;} |
sub AUTOLOAD
{ my $self = shift;
my $attr = $AUTOLOAD;
$attr =~ s/.*:://;
$attr = uc $attr;
$self->throw("Unallowed parameter: $attr !") unless $OK_FIELD{$attr};
$self->{$attr} = shift if @_;
return $self->{$attr};} |
sub version
{ my ($self) = @_;
return undef unless $self->executable;
my $prog = $self->executable;
my $string = `$prog -version`;
$string =~ /(Version *)/i;
return $1 || undef;} |
sub run
{ my ($self, $seq1, $seq2)=@_;
my ($attr, $value, $switch);
$self->io->_io_cleanup();
my ($infile1,$infile2)= $self->_setinput($seq1, $seq2);
if (!($infile1 && $infile2))
{$self->throw("Bad input data (sequences need an id ) ");}
my @fp = $self->_run($infile1,$infile2);
return @fp;} |
sub _run
{ my ($self,$infile1,$infile2) = @_;
my $instring;
$self->debug( "Program ".$self->executable."\n");
unless ( $self->executable ) {
$self->throw("Cannot run Promoterwise unless the executable is found.".
" Check your environment variables or make sure ".
"promoterwise is in your path.");
}
my $paramstring = $self->_setparams;
my $commandstring = $self->executable." $infile1 $infile2 $paramstring";
if( ( $self->silent && $self->quiet) &&
($^O !~ /os2|dos|MSWin32|amigaos/) ) {
$commandstring .= ' -quiet -silent -erroroffstd 2> /dev/null';
}
$self->debug( "promoterwise command = $commandstring");
open(PW, "$commandstring |") ||
$self->throw( "Promoterwise call ($commandstring) crashed: $?\n ");
my $pw_parser = Bio::Tools::Promoterwise->new(-fh=>\*PW,
-query1_seq=>$self->_query1_seq,
-query2_seq=>$self->_query2_seq);
my @fp;
while (my $fp = $pw_parser->next_result){
push @fp,$fp;
}
return @fp;} |
sub _setinput
{ my ($self, $seq1, $seq2) = @_;
my ($tfh1,$tfh2,$outfile1,$outfile2);
$self->throw("calling with not enough arguments") unless $seq1 && $seq2;
unless( ref($seq1) ) {
unless( -e $seq1 ) {
$self->throw("Sequence1 is not a Bio::PrimarySeqI object nor file\n");
}
$outfile1 = $seq1;
}
else {
($tfh1,$outfile1) = $self->io->tempfile(-dir=>$self->tempdir);
my $out1 = Bio::SeqIO->new('-fh' => $tfh1,
'-format' => 'fasta');
$out1->write_seq($seq1);
$self->_query1_seq($seq1);
close($tfh1);
undef $tfh1;
}
unless( ref($seq2) ) {
unless( -e $seq2 ) {
$self->throw("Sequence2 is not a Bio::PrimarySeqI object nor file\n");
}
$outfile2 = $seq2;
}
else {
($tfh2,$outfile2) = $self->io->tempfile(-dir=>$self->tempdir);
my $out2 = Bio::SeqIO->new('-fh' => $tfh2,
'-format' => 'fasta');
$out2->write_seq($seq2);
$self->_query2_seq($seq2);
close($tfh2);
undef $tfh2;
}
return ($outfile1,$outfile2);} |
sub _setparams
{ my ($self) = @_;
my $param_string;
foreach my $attr(@PROMOTERWISE_PARAMS){
my $value = $self->$attr();
next unless (defined $value);
my $attr_key = ' -'.(lc $attr);
$param_string .= $attr_key.' '.$value;
}
foreach my $attr(@PROMOTERWISE_SWITCHES){
my $value = $self->$attr();
next unless (defined $value);
my $attr_key = ' -'.(lc $attr);
$param_string .=$attr_key;
}
$param_string = $param_string." -hitoutput tab"; return $param_string;} |
sub _query1_seq
{ my ($self,$seq) = @_;
if(defined $seq){
$self->{'_query1_seq'} = $seq;
}
return $self->{'_query1_seq'};} |
sub _query2_seq
{ my ($self,$seq) = @_;
if(defined $seq){
$self->{'_query2_seq'} = $seq;
}
return $self->{'_query2_seq'};
}
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 one
of 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
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.
The rest of the documentation details each of the object
methods. Internal methods are usually preceded with a _
Title : _query_pep_seq
Usage : Internal function, not to be called directly
Function: get/set for the query sequence
Example :
Returns :
Args :
Title : _subject_dna_seq
Usage : Internal function, not to be called directly
Function: get/set for the subject sequence
Example :
Returns :
Args :