NAME
Bio::DB::DBFetch - Database object for retrieving using the dbfetch script
SYNOPSIS
#do not use this module directly
DESCRIPTION
Allows the dynamic retrieval of entries from databases using the dbfetch script at EBI: http://www.ebi.ac.uk/cgi-bin/dbfetch.
In order to make changes transparent we have host type (currently only ebi) and location (defaults to ebi) separated out. This allows later additions of more servers in different geographical locations.
This is a superclass which is called by instantiable subclasses with correct parameters.
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.
[email protected] - General discussionhttp://bioperl.org/wiki/Mailing_lists - About the mailing lists
Support
Please direct usage questions or support issues to the mailing list:
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://github.com/bioperl/bioperl-live/issues
AUTHOR - Heikki Lehvaslaiho
Email Heikki Lehvaslaiho <heikki-at-bioperl-dot-org>
APPENDIX
The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _
Routines from Bio::DB::WebDBSeqI
get_request
Title : get_requestUsage : my $url = $self->get_requestFunction: returns a HTTP::Request objectReturns :Args : %qualifiers = a hash of qualifiers (ids, format, etc)
postprocess_data
Title : postprocess_dataUsage : $self->postprocess_data ( 'type' => 'string','location' => \$datastr);Function: process downloaded data before loading into a Bio::SeqIOReturns : voidArgs : hash with two keys - 'type' can be 'string' or 'file'- 'location' either file location or stringreference containing data
default_format
Title : default_formatUsage : my $format = $self->default_formatFunction: Returns default sequence format for this moduleReturns : stringArgs : none
Bio::DB::DBFetch specific routines
get_Stream_by_id
Title : get_Stream_by_idUsage : $seq = $db->get_Stream_by_id($ref);Function: Retrieves Seq objects from the server 'en masse', rather than oneat a time. For large numbers of sequences, this is far superiorthan get_Stream_by_[id/acc]().Example :Returns : a Bio::SeqIO stream objectArgs : $ref : either an array reference, a filename, or a filehandlefrom which to get the list of unique ids/accession numbers.
NOTE: for backward compatibility, this method is also called get_Stream_by_batch.
get_Seq_by_version
Title : get_Seq_by_versionUsage : $seq = $db->get_Seq_by_version('X77802.1');Function: Gets a Bio::Seq object by accession numberReturns : A Bio::Seq objectArgs : version number (as a string)Throws : "version does not exist" exception
request_format
Title : request_formatUsage : my ($req_format, $ioformat) = $self->request_format;$self->request_format("genbank");$self->request_format("fasta");Function: Get/Set sequence format retrieval. The get-form will normally notbe used outside of this and derived modules.Returns : Array of two strings, the first representing the format forretrieval, and the second specifying the corresponding SeqIO format.Args : $format = sequence format
servertype
Title : servertypeUsage : my $servertype = $self->servertype$self->servertype($servertype);Function: Get/Set server typeReturns : stringArgs : server type string [optional]
hostlocation
Title : hostlocationUsage : my $location = $self->hostlocation()$self->hostlocation($location)Function: Set/Get HostlocationReturns : string representing hostlocationArgs : string specifying hostlocation [optional]
location_url
Title : locationUsage : my $url = $self->location_url()Function: Get host urlReturns : string representing urlArgs : none
Bio::DB::DBFetch routines
These methods allow subclasses to pass parameters.
hosts
Title : hostsUsage :Function: get/set for host hashReturns :Args : optional hash
formatmap
Title : formatmapUsage :Function: get/set for format hashReturns :Args : optional hash