Bio::Tools::Analysis::Protein Scansite
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvs
Summary
Bio::Tools::Analysis::Protein::Scansite - a wrapper around the Scansite server
Package variables
Privates (from "my" definitions)
$ANALYSIS_SPEC = { 'name' => 'Scansite', 'type' => 'Protein', 'version' => '2.0', 'supplier' => 'Massachusetts Institute of Technology', 'description' => 'Prediction of serine, threonine and tyrosine phosphorylation sites in eukaryotic proteins', }
$URL = 'http://scansite.mit.edu/cgi-bin/motifscan_seq'
$INPUT_SPEC = [ { 'mandatory' => 'true', 'type' => 'Bio::PrimarySeqI', 'name' => 'seq', }, { 'mandatory' => 'false', 'type' => 'text', 'name' => 'protein_id', 'default' => 'unnamed', }, { 'mandatory' => 'false', 'type' => 'text', 'name' => 'stringency', 'default' => 'High', }, ]
$RESULT_SPEC = { '' => 'bulk', 'Bio::SeqFeatureI' => 'ARRAY of Bio::SeqFeature::Generic', 'raw' => 'Array of {motif=>, percentile=>, position=>, protein=>, score=>, site=>, zscore=> sequence=> }', }
Included modules
Bio::SeqFeature::Generic
Bio::SeqIO
HTTP::Request::Common qw ( POST )
IO::String
Inherit
Bio::Tools::Analysis::SimpleAnalysisBase
Synopsis
  use Bio::Tools::Analysis::Protein::Scansite;
my $seq; # a Bio::PrimarySeqI object my $tool = Bio::Tools::Analysis::Protein::Scansite->new ( -seq => $seq->primary_seq ); # run Scansite prediction on a sequence $tool->run(); # alternatively you can say $tool->seq($seq->primary_seq)->run; die "Could not get a result" unless $tool->status =~ /^COMPLETED/; print $tool->result; # print raw prediction to STDOUT foreach my $feat ( $tool->result('Bio::SeqFeatureI') ) { # do something to SeqFeature # e.g. print as GFF print $feat->gff_string, "\n"; # or store within the sequence - if it is a Bio::RichSeqI $seq->add_SeqFeature($feat); }
Description
This class is a wrapper around the Scansite 2.0 server which produces
predictions for serine, threonine and tyrosine phosphorylation sites
in eukaryotic proteins. At present this is a basic wrapper for the
"Scan protein by input sequence" functionality, which takes a sequence
and searches for motifs, with the option to select the search
stringency. At present, searches for specific phosphorylation
sites are not supported; all predicted sites are returned. The Scansite results can be obtained in several formats:
   1.
   By calling
  my $res = $tool->result('');
   $res holds a string of the predicted sites in tabular format.
   2.
   By calling
  my $data_ref = $tool->result('value')
   $data_ref is a reference to an array of hashes. Each element in the
array represents a predicted phosphorylation site. The hash keys are
the names of the data fields,i.e.,
    'motif'      => 'Casn_Kin1'       # name of kinase
'percentile' => 0.155 # see Scansite docs
'position' => 9 # position in protein
'protein' => 'A1' # protein id
'score' => 0.3696 # see Scansite docs
'sequence' => 'ASYFDTASYFSADAT' # sequence surrounding site
'site' => 'S9' # phosphorylated residue
'zscore' => '-3.110' # see Scansite docs
   3.
   By calling
  my @fts = $tool->Result('Bio::SeqFeatureI');
   which returns an array of Bio::SeqFeatureI compliant objects with
primary tag value 'Site' and tag names of 'motif', 'score',
'sequence', 'zscore' as above.
See http://scansite.mit.edu/.
This inherits Bio::SimpleAnalysisI which hopefully makes it easier to
write wrappers on various services. This class uses a web resource and
therefore inherits from Bio::WebAgent.
Methods
resultDescriptionCode
stringencyDescriptionCode
protein_idDescriptionCode
_init
No description
Code
_run
No description
Code
_process_arguments
No description
Code
_make_header
No description
Code
_add_data
No description
Code
Methods description
resultcode    nextTop
 Name    : result
Usage : $job->result (...)
Returns : a result created by running an analysis
Args : none (but an implementation may choose
to add arguments for instructions how to process
the raw result)
The method returns a scalar representing a result of an executed
job. If the job was terminated by an error, the result may contain
an error message instead of the real data.
This implementation returns differently processed data depending on
argument:
   undef
   Returns the raw ASCII data stream but without HTML tags
   'Bio::SeqFeatureI'
   The argument string defined the type of bioperl objects returned in an
array. The objects are Bio::SeqFeature::Generic.
   'parsed'
   Returns a reference to an array of hashes containing the data of one
phosphorylation site prediction. Key values are:
   motif, percentile, position, protein, score, site, zscore, sequence.
stringencycodeprevnextTop
 Usage    : $job->stringency(...)
Returns : The significance stringency of a prediction
Args : None (retrieves value) or 'High', 'Medium' or 'Low'.
Purpose : Get/setter of the stringency to be sumitted for analysis.
protein_idcodeprevnextTop
 Usage    : $job->protein_id(...)
Returns : The sequence id of the protein or 'unnamed' if not set.
Args : None
Purpose : Getter of the seq_id. Returns the display_id of the sequence
object.
Methods code
resultdescriptionprevnextTop
sub result {
    my ($self,$value) = @_;
	if( !exists($self->{'_result'}) || $self->status ne 'COMPLETED'){
		$self->throw("Cannot get results, analysis not run!");
		}	
    my @fts;

    if ($value ) {
		if ($value eq 'Bio::SeqFeatureI') {
			for my $hit (@{$self->{'_parsed'}}) {
				push @fts, Bio::SeqFeature::Generic->new(
					-start       => $hit->{'position'},
					-end         => $hit->{'position'},
				    -primary_tag => 'Site',
					-source      => 'Scansite',
					-tag => {
						score     => $hit->{'score'},
						zscore    => $hit->{'zscore'},
						motif     => $hit->{'motif'},
						site      => $hit->{'site'},
						sequence  => $hit->{'sequence'},
							},
				);
			}
			return @fts;
		}
		elsif ($value eq 'meta') {
			$self->throw("No meta sequences available in this analysis!");
			}
		## else get here
return $self->{'_parsed'}; } return $self->{'_result'};
}
stringencydescriptionprevnextTop
sub stringency {
   my ($self,$value) = @_;
   if( $value) {
       if (! grep{$_=~ /$value/i}@STRINGENCY ) {
           $self->throw("I need a stringency of [".
						join " ", @STRINGENCY    .
						"], not [$value]");
       }
       $self->{'_stringency'} = $value;
       return $self;
   }
   return $self->{'_stringency'} || $self->input_spec->[2]{'default'} ;
}
protein_iddescriptionprevnextTop
sub protein_id {
	my $self = shift;
	return defined ($self->seq())? $self->seq->display_id()
				     : $self->input_spec->[1]{'default'};
}
_initdescriptionprevnextTop
sub _init {
	my $self = shift;
	$self->url($URL);
	$self->{'_ANALYSIS_SPEC'} = $ANALYSIS_SPEC;
	$self->{'_INPUT_SPEC'}    = $INPUT_SPEC;
	$self->{'_RESULT_SPEC'}   = $RESULT_SPEC;
	$self->{'_ANALYSIS_NAME'} = $ANALYSIS_SPEC->{'name'};
	return $self;
}
_rundescriptionprevnextTop
sub _run {
    my $self = shift;

    # format the sequence into fasta
$self->delay(1); # delay repeated calls by default by 3 sec, set delay() to change
$self->sleep; $self->status('TERMINATED_BY_ERROR'); my $request = POST $self->url, Content => [sequence => $self->seq->seq(), protein_id => $self->protein_id(), motif_option => 'all', motifs => '', motif_groups => '', stringency => $self->stringency(), #domain_flag => '',
submit => "Submit Request", ]; ## raw html report,
my $content = $self->request($request); my $text = $content->content; ##access result data from tag in html
my @parsed_Results = (); my @unwantedParams = qw(db source class); my @results = split /sitestats\.phtml\?/, $text; shift @results; ##this module generates 'parsed' output directly from html,
## avoids having toparse twice.
for my $hit (@results) { ## get results string
my ($res) = $hit =~ /^(.+?)"/; #get key value pairs
my %params = $res =~/(\w+)=([^&]+)/g; ##remove unwanted data from hash
map{delete $params{$_}} @unwantedParams; push @parsed_Results,\% params; } ## now generate text output in table format
my $out_Str = ''; $out_Str .= $self->_make_header(\@parsed_Results); $out_Str .= $self->_add_data(\@parsed_Results); $self->{'_result'} = $out_Str; $self->{'_parsed'} =\@ parsed_Results; ## is successsful if there are results or if there are no results and
## this beacuse there are no matches, not because of parsing errors etc.
$self->status('COMPLETED') if $text ne '' && (scalar @results > 0 || (scalar @results == 0 && $text =~/No sites found/)); if ($text =~ /server\s+error/i) { $self->throw("Internal server error:\n\n $text"); return; }
}
_process_argumentsdescriptionprevnextTop
sub _process_arguments {
    # extra checking for sequence length
# mitoprot specific argument testing
my ($self, $args) = @_; #use base checking for existence of mandatory fields
$self->SUPER::_process_arguments($args); # specific requirements
$self->throw("Sequence must be > 15 amino acids long!") if $self->seq->length < 15; $self->throw("Sequence must be protein") unless $self->seq->alphabet() eq 'protein';
}
_make_headerdescriptionprevnextTop
sub _make_header {
	my ($self, $res) = @_;
	my $header = '';
	for my $k (sort keys %{$res->[0]} ){
		next if $k eq 'sequence';
		$header .= $k;
		$header .= ' 'x(12 -length($k));
	}
	$header .= "sequence\n\n";
	return $header;
}
_add_datadescriptionprevnextTop
sub _add_data {
	my ($self, $res) = @_;
	my $outstr = '';
	for my $hit  (@$res) {
		for my $k (sort keys %$hit ){
			next if $k eq 'sequence';
			$outstr .= $hit->{$k};
			$outstr .= ' 'x(12 - length($hit->{$k}));
			}
		$outstr .= $hit->{'sequence'}. "\n" if $hit->{'sequence'};
	}
	return $outstr;


}
	

1;
}
General documentation
SEE ALSOTop
Bio::SimpleAnalysisI,
Bio::WebAgent
FEEDBACKTop
Mailing ListsTop
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
Support Top
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.
Reporting BugsTop
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:
  https://redmine.open-bio.org/projects/bioperl/
AUTHORSTop
Richard Adams, Richard.Adams@ed.ac.uk,
APPENDIXTop
The rest of the documentation details each of the object
methods. Internal methods are usually preceded with a _