Bio::Tools::Run
Coil
Toolbar
Summary
Bio::Tools::Run::Coil - wrapper for ncoils program
Package variables
No package variables defined.
Included modules
Bio::Root::IO
Bio::Root::Root
Bio::SeqIO
Bio::Tools::Coil
Bio::Tools::Run::WrapperBase
Inherit
Bio::Root::Root Bio::Tools::Run::WrapperBase
Synopsis
# Build a Coil factory
my $factory = Bio::Tools::Run::Coil->new($params);
# Pass the factory a Bio::Seq object
# @feats is an array of Bio::SeqFeature::Generic objects
my @feats = $factory->run($seq);
Description
This module is a wrapper for the
ncoils program available via
http://www.russell.embl-heidelberg.de/coils/coils.tar.gz for predicting
coiled coils in protein sequences.
By default it looks for an executable called
ncoils and data/parameter files
in the directory specified by the
COILSDIR environmental variable.
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 : new Usage : $coil->new(@params) Function: creates a new Coil factory Returns: Bio::Tools::Run::Coil Args : |
Title : predict_protein_features() Usage : DEPRECATED. Use $obj->run instead. Function: Runs Coil and creates an array of featrues Returns : An array of Bio::SeqFeature::Generic objects Args : A Bio::PrimarySeqI |
Title : run Usage : $obj->run($seq) Function: Runs Coil and creates an array of featrues Returns : An array of Bio::SeqFeature::Generic objects Args : A Bio::PrimarySeqI, or a Fasta filename. |
Title : _run Usage : $obj->_run() Function: Internal(not to be used directly) Returns : An array of Bio::SeqFeature::Generic objects Args : |
Title : _writeSeqFile Usage : obj->_writeSeqFile($seq) Function: Internal(not to be used directly) Returns : Args : |
Methods code
BEGIN { @COIL_PARAMS=qw(PROGRAM VERBOSE QUIET SILENT);
foreach my $attr ( @COIL_PARAMS)
{ $OK_FIELD{$attr}++;} |
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 program_name
{ return 'ncoils'; } |
sub program_dir
{ return Bio::Root::IO->catfile($ENV{COILSDIR}) if $ENV{COILSDIR};} |
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 =~ /^-/ ); if ($attr =~/PROGRAM/i) {
$self->executable($value);
next;
}
$self->$attr($value);
}
return $self;} |
sub predict_protein_features
{ return shift->run(@_); } |
sub run
{ my ($self,$seq) = @_;
my @feats;
if (ref($seq) ) { if (ref($seq) =~ /GLOB/) {
$self->throw("cannot use filehandle");
}
my $infile1 = $self->_writeSeqFile($seq);
$self->_input($infile1);
@feats = $self->_run();
unlink $infile1;
}
else {
$self->_input($seq);
@feats = $self->_run();
}
return @feats;} |
sub _input()
{ my ($self,$infile1) = @_;
if(defined $infile1){
$self->{'input'}=$infile1;
}
return $self->{'input'};} |
sub _run
{ my ($self)= @_;
my ($tfh1,$outfile) = $self->io->tempfile(-dir=>$self->tempdir());
my $str =$self->executable." -f < ".$self->{'input'}." > ".$outfile;
if($self->quiet || $self->verbose <=0 || $self->silent){
$str.=" 2>/dev/null";
}
my $status = system($str);
$self->throw( "Coil call ($str) crashed: $?\n ") unless $status==0;
my $coil_parser = Bio::Tools::Coil->new();
my $filehandle;
if (ref ($outfile) !~ /GLOB/) {
open (COIL, "<".$outfile) or $self->throw ("Couldn't open file ".$outfile.": $!\n");
$filehandle =\* COIL;
}
else {
$filehandle = $outfile;
}
my @coil_feat;
while(my $coil_feat = $coil_parser->next_result($filehandle)){
push @coil_feat, $coil_feat;
}
$self->cleanup();
close($tfh1);
undef $tfh1;
unlink $outfile;
return @coil_feat;} |
sub _writeSeqFile
{ my ($self,$seq) = @_;
my ($tfh,$inputfile) = $self->io->tempfile(-dir=>$self->tempdir());
my $in = Bio::SeqIO->new(-fh => $tfh , '-format' => 'Fasta');
$in->write_seq($seq);
return $inputfile;
}
1;} |
General documentation
Lupas, van Dyke & Stock,
Predicting coiled coils from protein sequences,
Science 252:1162-1164, 1991.
Lupas, A.,
Prediction and Analysis of Coiled-Coil Structures,
Meth. Enzymology 266:513-525, 1996.
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 : _input
Usage : obj->_input($seqFile)
Function: Internal(not to be used directly)
Returns :
Args :