| Summary | Package variables | Synopsis | Description | General documentation | Methods |
| Summary | Top |
| Clair::Bio::EUtils::ESearch - a Perl interface to the ESearch utility |
| Package variables | Top |
| No package variables defined. |
| Included modules | Top |
| Carp |
| Clair::Bio::EUtils qw ( $ESEARCH_URL $TOOL $EMAIL build_url ) |
| Clair::Bio::EUtils::ESearchHandler |
| LWP::Simple |
| XML::Parser::PerlSAX |
| Synopsis | Top |
|
| Description | Top |
| The ESearch utility is used to query a database and return a list of ids. For example, search PubMed for articles and return a list of PMIDs. For a complete description, see the ESearch specification on the Entrez website. |
| Methods | Top |
| get_esearch_args | Description | Code |
| new | Description | Code |
| get_esearch_args | code | next | Top |
| Returns a hash of the arguments passed to ESearch. |
| new | code | prev | next | Top |
my $esearch = new Clair::Bio::EUtils::ESearch( |
| get_esearch_args | description | prev | next | Top |
sub get_esearch_args
{ my $self = shift;
if (defined $self->{_esearch_args}) {
return %{ $self->{_esearch_args} };
} else {
return undef;
}} |
| new | description | prev | next | Top |
sub new
{ my $class =shift;
my $self = {};
my %params = @_;
my %esearch_args = (
db => "PubMed",
usehistory => "y",
);
# Merge with the defaults} |
| REQUIRES | Top |
| Clair::Bio::EUtils Clair::Bio::EUtils::ESearchHandler LWP::Simple XML::Parser::PerlSAX |
| AUTHOR | Top |
| Tony Fader, afader@umich.edu |
| SEE ALSO | Top |
| The ESearch specification on the Entrez site: http://www.ncbi.nlm.nih.gov/entrez/query/static/esearch_help.html. |