/ 
bioperl-1.5.2_004-RCb
/ Bio::DB::EUtilities::einfo

NAME

Bio::DB::EUtilities::einfo - NCBI database information

SYNOPSIS

my $einfo = Bio::DB::EUtilities->new(
                                   -eutil    => 'einfo',
                                   -db       => 'pubmed'
                                    );

print $einfo->get_response->content;

DESCRIPTION

EInfo queries provide information about NCBI databases. At this time, data is postprocessed for a complete list of Entrez databases (when '-db' is not set) or for specific database information, number of entries, date of the last update, or Field or Link information. Using the base URL with no parameters returns a list of all Entrez databases.

Parameters

The following are a general list of parameters that can be used to take advantage of EInfo. Up-to-date help for EInfo is available at this URL (the information below is a summary of the options found there):

http://eutils.ncbi.nlm.nih.gov/entrez/query/static/einfo_help.html
db

Database parameter. This is optional; not setting this will return a list of all the available Entrez databases. If a database is specified, returned XML data will provide the following information : field names, index term counts, last update, and available links for each Entrez database.

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

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.

http://bugzilla.open-bio.org/

AUTHOR

Email cjfields at uiuc dot edu

APPENDIX

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _

parse_response

Title   : parse_response
Usage   : $db->_parse_response($content)
Function: parse out response for cookie
Returns : empty
Args    : none
Throws  : 'unparseable output exception'

einfo_dbfield_info

Title   : einfo_dbfield_info
Usage   : @fields = $info->einfo_dbfield_info;
Function: gets array of hashes with field information
Returns : An array or array reference (based on wantarray) of hashes
          with information about each field 
Args    : None (this is set using the _set_einfo_data method)
Title   : einfo_dblink_info
Usage   : @links = $info->einfo_dblink_info;
Function: gets array of hashes with link information
Returns : An array or array reference (based on wantarray) of hashes
          with information about each link 
Args    : None (this is set using the _set_einfo_data method)

einfo_db_lastupdate

Title   : einfo_db_last_update
Usage   : $date = $info->einfo_db_lastupdate;
Function: returns last date database was updated
Returns : String containing date
Args    : None (this is set using the _set_einfo_data method)

einf_db_desc

Title   : einfo_db_desc
Usage   : $desc = $info->einfo_db_desc;
Function: returns database description
Returns : String containing descriptions
Args    : None (this is set using the _set_einfo_data method)

einfo_db_count

Title   : einfo_db_count
Usage   : $count = $info->einfo_db_count;
Function: returns database record count
Returns : Integer (number of database records)
Args    : None (this is set using the _set_einfo_data method)