bio::search::hsp::hspfactory(3pm) [debian man page]
Bio::Search::HSP::HSPFactory(3pm) User Contributed Perl Documentation Bio::Search::HSP::HSPFactory(3pm)NAME
Bio::Search::HSP::HSPFactory - A factory to create Bio::Search::HSP::HSPI objects
SYNOPSIS
use Bio::Search::HSP::HSPFactory;
my $factory = Bio::Search::HSP::HSPFactory->new();
my $resultobj = $factory->create(@args);
DESCRIPTION
This is a general way of hiding the object creation process so that we can dynamically change the objects that are created by the SearchIO
parser depending on what format report we are parsing.
This object is for creating new HSPs.
FEEDBACK
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 list. Your participation is much appreciated.
bioperl-l@bioperl.org - General discussion
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
Support
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 Bugs
Report bugs to the Bioperl bug tracking system to help us keep track of the bugs and their resolution. Bug reports can be submitted via the
web:
https://redmine.open-bio.org/projects/bioperl/
AUTHOR - Jason Stajich
Email jason-at-bioperl.org
APPENDIX
The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _
new
Title : new
Usage : my $obj = Bio::Search::HSP::HSPFactory->new();
Function: Builds a new Bio::Search::HSP::HSPFactory object
Returns : Bio::Search::HSP::HSPFactory
Args :
create
Title : create
Usage : $factory->create(%args)
Function: Create a new L<Bio::Search::HSP::HSPI> object
Returns : L<Bio::Search::HSP::HSPI>
Args : hash of initialization parameters
type
Title : type
Usage : $factory->type('Bio::Search::HSP::GenericHSP');
Function: Get/Set the HSP creation type
Returns : string
Args : [optional] string to set
perl v5.14.2 2012-03-02 Bio::Search::HSP::HSPFactory(3pm)
Check Out this Related Man Page
Bio::Search::HSP::HmmpfamHSP(3pm) User Contributed Perl Documentation Bio::Search::HSP::HmmpfamHSP(3pm)NAME
Bio::Search::HSP::HmmpfamHSP - A parser and HSP object for hmmpfam hsps
SYNOPSIS
# generally we use Bio::SearchIO to build these objects
use Bio::SearchIO;
my $in = Bio::SearchIO->new(-format => 'hmmer_pull',
-file => 'result.hmmer');
while (my $result = $in->next_result) {
while (my $hit = $result->next_hit) {
print $hit->name, "
";
print $hit->score, "
";
print $hit->significance, "
";
while (my $hsp = $hit->next_hsp) {
# process HSPI objects
}
}
}
DESCRIPTION
This object implements a parser for hmmpfam hsp output, a program in the HMMER package.
FEEDBACK
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 list. Your participation is much appreciated.
bioperl-l@bioperl.org - General discussion
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
Support
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 Bugs
Report bugs to the Bioperl bug tracking system to help us keep track of the bugs and their resolution. Bug reports can be submitted via the
web:
https://redmine.open-bio.org/projects/bioperl/
AUTHOR - Sendu Bala
Email bix@sendu.me.uk
APPENDIX
The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _
new
Title : new
Usage : my $obj = Bio::Search::HSP::HmmpfamHSP->new();
Function: Builds a new Bio::Search::HSP::HmmpfamHSP object.
Returns : Bio::Search::HSP::HmmpfamHSP
Args : -chunk => [Bio::Root::IO, $start, $end] (required if no -parent)
-parent => Bio::PullParserI object (required if no -chunk)
-hsp_data => array ref with [rank query_start query_end hit_start
hit_end score evalue]
where the array ref provided to -chunk contains an IO object
for a filehandle to something representing the raw data of the
hsp, and $start and $end define the tell() position within the
filehandle that the hsp data starts and ends (optional; defaults
to start and end of the entire thing described by the filehandle)
query
Title : query
Usage : my $query = $hsp->query
Function: Returns a SeqFeature representing the query in the HSP
Returns : L<Bio::SeqFeature::Similarity>
Args : none
hit
Title : hit
Usage : my $hit = $hsp->hit
Function: Returns a SeqFeature representing the hit in the HSP
Returns : L<Bio::SeqFeature::Similarity>
Args : [optional] new value to set
gaps
Title : gaps
Usage : my $gaps = $hsp->gaps( ['query'|'hit'|'total'] );
Function : Get the number of gaps in the query, hit, or total alignment.
Returns : Integer, number of gaps or 0 if none
Args : 'query' = num conserved / length of query seq (without gaps)
'hit' = num conserved / length of hit seq (without gaps)
'total' = num conserved / length of alignment (with gaps)
default = 'total'
pvalue
Title : pvalue
Usage : my $pvalue = $hsp->pvalue();
Function: Returns the P-value for this HSP
Returns : undef (Hmmpfam reports do not have p-values)
Args : none
perl v5.14.2 2012-03-02 Bio::Search::HSP::HmmpfamHSP(3pm)