Bio::Search::Result::ResultI.pm - Abstract interface to Result objects
These objects are generated automatically by Bio::Search::Processor objects, and wouldn't be used directly.
Bio::Search::Result::* objects are data structures containing the results from the execution of a search algorithm. As such, it may contain various algorithm specific information as well as details of the execution, but will contain a few fundamental elements, including the ability to return Bio::Search::Hit::* objects.
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.
vsns-bcd-perl@lists.uni-bielefeld.de - General discussion vsns-bcd-perl-guts@lists.uni-bielefeld.de - Technically-oriented discussion http://bio.perl.org/MailList.html - About the mailing lists
Report bugs to the Bioperl bug tracking system to help us keep track the bugs and their resolution. Bug reports can be submitted via email or the web:
bioperl-bugs@bio.perl.org http://bio.perl.org/bioperl-bugs/
Email amackey@virginia.edu
The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _
Title : get_query_id Usage : $id = $result->get_query_id(); Function: Used to obtain the string identifier of the query used by the algorithm. Returns : a scalar string. Args : <none>
Title : get_library_name Usage : $name = $result->get_library_name() Function: Used to obtain the name of the library that the query was searched against by the algorithm. Returns : a scalar string Args : <none>
Title : get_library_size Usage : $size = $result->get_library_size() Function: Used to obtain the size of library that was searched against. Returns : a scalar integer (units specific to algorithm, but probably the total number of residues in the library, if available) or undef if the information was not available to the Processor object. Args : <none>
Title : get_library_count Usage : $count = $result->get_library_count() Function: Used to obtain the number of entries contained in the library. Returns : a scalar integer representing the number of entities in the library or undef if the information was not available. Args : <none>
Title : get_hits Usage : @hits = $result->get_hits(); Function: Used to obtain the array of hit objects, representing potential matches between the query and various entities from the library. Returns : an array of Bio::Search::Hit::* object (specific type depends on algorithm), or undef if there were none. Args : <none>
To install Bio::Seq, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Bio::Seq
CPAN shell
perl -MCPAN -e shell install Bio::Seq
For more information on module installation, please visit the detailed CPAN module installation guide.