Bio::Tools::Run
RepeatMasker
Toolbar
Summary
Bio::Tools::Run::RepeatMasker - Wrapper for RepeatMasker Program
Package variables
No package variables defined.
Included modules
Bio::Root::Root
Bio::SeqFeature::FeaturePair
Bio::SeqFeature::Generic
Bio::Tools::RepeatMasker
Bio::Tools::Run::WrapperBase
Inherit
Bio::Root::Root Bio::Tools::Run::WrapperBase
Synopsis
use Bio::Tools::Run::RepeatMasker;
my @params=("mam" => 1,"noint"=>1);
my $factory = Bio::Tools::Run::RepeatMasker->new(@params);
$in = Bio::SeqIO->new(-file => "contig1.fa",
-format => 'fasta');
my $seq = $in->next_seq();
#return an array of Bio::SeqFeature::FeaturePair objects
my @feats = $factory->run($seq);
# or
$factory->run($seq);
my @feats = $factory->repeat_features;
#return the masked sequence, a Bio::SeqI object
my $masked_seq = $factory->run;
Description
To use this module, the RepeatMasker program (and probably database) must be
installed. RepeatMasker is a program that screens DNA sequences for interspersed
repeats known to exist in mammalian genomes as well as for low
complexity DNA sequences. For more information, on the program and its
usage, please refer to
http://www.repeatmasker.org/.
Having installed RepeatMasker, you must let Bioperl know where it is.
This can be done in (at least) three ways:
1. Make sure the RepeatMasker executable is in your path.
2. Define an environmental variable REPEATMASKERDIR which is a
directory which contains the RepeatMasker executable:
In bash:
export REPEATMASKERDIR=/home/username/RepeatMasker/
In csh/tcsh:
setenv REPEATMASKERDIR /home/username/RepeatMasker/
3. Include a definition of an environmental variable REPEATMASKERDIR in
every script that will use this RepeatMasker wrapper module, e.g.:
BEGIN { $ENV{REPEATMASKERDIR} = '/home/username/RepeatMasker/' }
use Bio::Tools::Run::RepeatMasker;
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 : $rm->new($seq) Function: creates a new wrapper Returns: Bio::Tools::Run::RepeatMasker Args : self |
Title : version Usage : Function: Determine the version number of the program Example : Returns : float or undef Args : none |
Title : run Usage : $rm->run($seq); Function: Run Repeatmasker on the sequence set as the argument Returns : an array of repeat features that are Bio::SeqFeature::FeaturePairs Args : Bio::PrimarySeqI compliant object |
Title : mask Usage : $rm->mask($seq) Function: This method is deprecated. Call run() instead Example : Returns : an array of repeat features that are Bio::SeqFeature::FeaturePairs Args : Bio::PrimarySeqI compliant object |
Title : _run Usage : $rm->_run ($filename,$param_string) Function: internal function that runs the repeat masker Example : Returns : an array of repeat features Args : the filename to the input sequence and the parameter string |
Title : masked_seq Usage : $rm->masked_seq($seq) Function: get/set for masked sequence Example : Returns : the masked sequence Args : Bio::Seq object |
Title : repeat_features Usage : $rm->repeat_features(\@rf) Function: get/set for repeat features array Example : Returns : the array of repeat features Args : |
Title : _setparams Usage : Internal function, not to be called directly Function: Create parameter inputs for repeatmasker program Example : Returns : parameter string to be passed to repeatmasker Args : name of calling object |
Title : _setinput Usage : Internal function, not to be called directly Function: writes input sequence to file and return the file name Example : Returns : string Args : a Bio::PrimarySeqI compliant object |
Methods code
BEGIN { @RM_PARAMS = qw(DIR DIV LIB CUTOFF PARALLEL GC FRAG SPECIES MAXSIZE );
@RM_SWITCHES = qw(NOLOW LOW L NOINT INT NORNA ALU M MUS ROD
RODENT MAM MAMMAL COW AR
ARABIDOPSIS DR DROSOPHILA EL ELEGANS
IS_ONLY IS_CLIP NO_IS RODSPEC E EXCLN
NO_ID FIXED XM U GFF ACE POLY X XSMALL SMALL
INV A ALIGNMENTS
PRIMSPEC W WUBLAST S Q QQ GCCALC NOCUT);
@OTHER_SWITCHES = qw(NOISY QUIET SILENT);
foreach my $attr ( @RM_PARAMS, @RM_SWITCHES,
@OTHER_SWITCHES) { $OK_FIELD{$attr}++;} |
sub program_name
{ return 'RepeatMasker'; } |
sub program_dir
{ return Bio::Root::IO->catfile($ENV{REPEATMASKERDIR}) if $ENV{REPEATMASKERDIR};} |
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 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);
}
unless ($self->executable()) {
if( $self->verbose >= 0 ) {
warn "RepeatMasker program not found as ".($self->executable||'').
" or not executable.\n ";
}
}
return $self; } |
sub version
{ my ($self) = @_;
return $self->{'_version'} if( defined $self->{'_version'} );
my $exe = $self->executable;
return undef unless $exe;
my $string = `$exe -- ` ;
if( $string =~ /\(([\d.]+)\)/ ||
$string =~ /RepeatMasker\s+version\s+(\S+)/ ) {
return $self->{'_version'} = $1;
} else {
return $self->{'_version'} = undef;
}} |
sub run
{ my ($self,$seq) = @_;
my ($infile);
$infile = $self->_setinput($seq);
my $param_string = $self->_setparams();
my @repeat_feats = $self->_run($infile,$param_string);
return @repeat_feats; } |
sub mask
{ return shift->run(@_); } |
sub _run
{ my ($self,$infile,$param_string) = @_;
my $instring;
$self->debug( "Program ".$self->executable."\n");
my $outfile = $infile.".out";
my $cmd_str = $self->executable." $param_string ". $infile;
$self->debug("repeat masker command = $cmd_str");
if ($self->quiet || $self->verbose <=0){
$cmd_str.=" 2> /dev/null 1>/dev/null";
}
my $status = system($cmd_str);
$self->throw("Repeat Masker Call($cmd_str) crashed: $?\n")
unless $status == 0;
unless (open (RM, $outfile)) {
$self->throw("Cannot open RepeatMasker outfile for parsing");
}
my $rpt_parser = Bio::Tools::RepeatMasker->new(-fh=>\*RM);
my @rpt_feat;
while(my $rpt_feat = $rpt_parser->next_result){
push @rpt_feat, $rpt_feat;
}
$self->repeat_features(\@rpt_feat);
my $masked = $infile.".masked";
my $seqio = Bio::SeqIO->new(-file=>$masked,-format=>'FASTA');
$self->masked_seq($seqio->next_seq);
return @rpt_feat;} |
sub masked_seq
{ my ($self,$seq) = @_;
if($seq){
$self->{'_masked_seq'} = $seq;
}
return $self->{'_masked_seq'};} |
sub repeat_features
{ my ($self,$rf) = @_;
if($rf) {
$self->{'_rf'} = $rf;
}
return @{$self->{'_rf'}};} |
sub _setparams
{ my ($attr, $value, $self);
$self = shift;
my $param_string = "";
for $attr ( @RM_PARAMS ) {
$value = $self->$attr();
next unless (defined $value);
my $attr_key = lc $attr;
$attr_key = ' -'.$attr_key;
$param_string .= $attr_key.' '.$value;
}
for $attr ( @RM_SWITCHES) {
$value = $self->$attr();
next unless ($value);
my $attr_key = lc $attr; $attr_key = ' -'.$attr_key;
$param_string .= $attr_key ;
}
return $param_string;} |
sub _setinput
{ my ($self,$seq) = @_;
$seq->isa("Bio::PrimarySeqI") ||
$self->throw("Need a Bio::PrimarySeq compliant object for RepeatMasker");
my ($tfh1,$outfile1) = $self->io->tempfile(-dir=>$self->tempdir);
my $out1 = Bio::SeqIO->new(-fh=> $tfh1 , '-format' => 'fasta');
$out1->write_seq($seq);
close($tfh1);
undef $tfh1;
return ($outfile1);} |
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.
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://bugzilla.open-bio.org/
The rest of the documentation details each of the object
methods. Internal methods are usually preceded with a "_".
| Bio::Tools::Run::Wrapper 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 : outfile_name
Usage : my $outfile = $codeml->outfile_name();
Function: Get/Set the name of the output file for this run
(if you wanted to do something special)
Returns : string
Args : [optional] string to set value to
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 : $codeml->cleanup();
Function: Will cleanup the tempdir directory
Returns : none
Args : none