Christopher Fields > BioPerl-Run > Bio::DB::SoapEUtilities::GQueryAdaptor

Download:
BioPerl-Run-1.006900.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  1
View/Report Bugs
Source  

NAME ^

Bio::DB::SoapEUtilities::GQueryAdaptor - Handle for Entrez SOAP GlobalQuery items

SYNOPSIS ^

 my $fac = Bio::DB::SoapEUtilities->new();
 # run a query, returning a GQueryAdaptor
 my $queries = $fac->egquery( -term => 'BRCA and human' )->run(-auto_adapt=>1);
 # all databases with hits
 my @dbs = $queries->found_in_dbs;
 # queries by database
 my $prot_count = $queries->query_by_db('prot')->count;
 # iterate over gquery
 while ( my $q = $queries->next_query ) {
    my $db = $q->db;
    my $count = $q->count;
    my $status = $q->status;
 }

DESCRIPTION ^

This adaptor provides an iterator (next_query()) and other convenience functions for parsing NCBI Entrez EUtility egquery SOAP results.

SEE ALSO ^

Bio::DB::SoapEUtilities

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:

  http://redmine.open-bio.org/projects/bioperl/

AUTHOR - Mark A. Jensen ^

Email maj -at- fortinbras -dot- us

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 = new Bio::DB::SoapEUtilities::GQueryAdaptor();
 Function: Builds a new Bio::DB::SoapEUtilities::GQueryAdaptor object
 Returns : an instance of Bio::DB::SoapEUtilities::GQueryAdaptor
 Args    :

next_query()

 Title   : next_query
 Usage   : 
 Function: return the next global query from the attached Result
 Returns : 
 Args    : 

found_in_dbs()

 Title   : found_in_dbs
 Usage   : 
 Function: Return list of db names containing hits for 
           the query term
 Returns : array of scalar strings
 Args    : none

query_by_db()

 Title   : query_by_db
 Usage   : 
 Function: get gquery object by db name
 Returns : 
 Args    : db name (scalar string)
syntax highlighting: