NAME¶
Bio::Tools::EUtilities::HistoryI - simple extension of EUtilDataI interface
class for classes which hold NCBI server history data
SYNOPSIS¶
#should work for any class which is-a HistoryI
if ($obj->has_History) {
# do something here
}
($webenv, $querykey) = $obj->history;
$obj->history($webenv, $querykey);
$webenv = $obj->get_webenv;
$query_key = $obj->get_query_key;
DESCRIPTION¶
This class extends methods for any EUtilDataI implementation allow instances to
dealwith NCBI history data (WebEnv and query_key). These can be used as
parameters for further queries against data sets stored on the NCBI server,
much like NCBI's Entrez search history. These are important when one wants to
run complex queries using esearch, retrieve related data using elink, and
retrieve large datasets using epost/efetch.
The simplest implementation is Bio::Tools::EUtilities::History, which holds the
history data for epost. See also Bio::Tools::EUtilities::Query (esearch) and
Bio::Tools::EUtilities::LinkSet (elink), which also implement HistoryI.
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 one of the Bioperl
mailing lists. Your participation is much appreciated.
bioperl-l@lists.open-bio.org - General discussion
http://www.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 the bugs
and their resolution. Bug reports can be submitted via the web.
https://redmine.open-bio.org/projects/bioperl/
AUTHOR¶
Email cjfields at bioperl dot org
APPENDIX¶
The rest of the documentation details each of the object methods. Internal
methods are usually preceded with a _
history¶
Title : history
Usage : my ($webenv, $qk) = $hist->history
Function : Get/Set two-element list of webenv() and query_key()
Returns : array
Args : two-element list of webenv, querykey
get_webenv¶
Title : get_webenv
Usage : my $webenv = $hist->get_webenv
Function : returns web environment key needed to retrieve results from
NCBI server
Returns : string (encoded key)
Args : none
get_query_key¶
Title : get_query_key
Usage : my $qk = $hist->get_query_key
Function : returns query key (integer) for the history number for this session
Returns : integer
Args : none