view release on metacpan or  search on metacpan

script/pubmed.pl  view on Meta::CPAN

   --display (integer)               maximum hits to display
   --silent  (boolean)               does not list the hits
   --pmid    (boolean)               fetches entries by pmid instead of doing search query
   --xslt    (string)                xslt file to transform XML output

   --debug   (boolean)               turn verbose debug information ON
   --help    (boolean)               brief help message
   --man     (boolean)               full documentation

=head1 OPTIONS

=head2 --debug

Turn verbose debug information ON.

=head2 --help

Print a brief help message and exits.

=head2 --man

Prints the manual page and exits.

=head2 --pmid

Instead of retreiving via a search query entries are fetched via PubMed ID's.
This allows to control the type of information returned (--type).

=head2 --xslt

This is an optional path to a xslt file. It will be used to transform and output the incoming xml markup. The keywords "to_html" and "to_ascii" are reserved as a value which refers to internal xslt files.

=head2 --type

Return type format:

    "SGML" => "XML/SGML",  
    
    "DocSum" => "Summary",
    
    "Brief" => "Brief",
    
    "Abstract" => "Abstract",
    
    "Citation" => "Citation",
    
    "MEDLINE" => "MEDLINE",
    
    "ASN.1" => "ASN.1",
    
    "ExternalLink" => "LinkOut",

Deprecated are:

    "pmlink_Related" => "Related Articles",

    "pmlink_AALinks" => "Protein Links",
    
    "pmlink_DNALinks" => "Nucleotide Links",
    
    "pmlink_PSLinks" => "Popset Links",
    
    "pmlink_StrLinks" => "Structure Links",
    
    "pmlink_GenLinks" => "Genome Links",
    
    "pmlink_OmLinks" => "OMIM Links",

=head1 DESCRIPTION

B<pubmed> searches the PubMed service from the shell. It runs queries against the service cgi scripts (currently described by L<http://www.ncbi.nlm.nih.gov/entrez/utils/pmfetch_help.html> and returns the result locally interpreted (xml via xslt) or a...

=head1 QUERY FORMAT

Please visit L<http://www.ncbi.nlm.nih.gov/entrez/query/static/help/pmhelp.html> for a comprehensive introduction. Also
enhance to the section L</SEARCH FIELD TAGS> below to get a compressed overview of available query syntax.

=head2 FORMAT MODIFICATIONS

Because both, win32 default shell and query field, use double quotes as standard string text delimiters, shell doublequotes are required to be escaped.
I therefore added the translation of singlequotes to doulequotes to have a more convenient syntax.

 pubmed "'Birchmeier W' [au]" 

is translated to (more cryptic)

 pubmed "\"Birchmeier W\" [au]" 

Note that this is just a simple replacement within the query string syntax from the shell tool, not the web search form field.

=head1 IMPORTANT NOTE (from the service provider)

=head2 SERVICE LOAD

Do not overload NCBI's systems. Users intending to send numerous queries and/or retrieve large numbers of records from Entrez should comply with the following: Run retrieval scripts between 7 PM and 5 AM Eastern Time weekdays or any time on weekends....

=head2 COPYRIGHT

NCBI's Disclaimer and Copyright notice must be evident to users of your service. NLM does not hold the copyright on the abstracts found in PubMed, the journal publishers do. NLM provides no legal advice concerning distribution of copyrighted material...

=head2 IDENTIFIER NUMBERS

Note: In the future a MEDLINE UI will no longer be assigned to PubMed citations. Citations will only be assigned a PubMed UI (PMID).

=head1 EXAMPLES

=head2 Lists the 10 most recent entries from the author "Birchmeier W"

 pubmed "'Birchmeier W' [au]" --display 10

=head2 Lists the 10 most recent entries from the author "Paus R" with the string "hair" in the title

 pubmed "'Paus>[au] AND hair[ti]' --display 10

=head2 Query all publications from "Paus-R" with mesh heading 'hair follicle'

 pubmed "'Paus-R' [au] AND hair follicle[me]" --display 10

=head2 Query all publications with "hair follicle" or "anagen" anywhere in the record

 pubmed "hair follicle [ALL] OR anagen [ALL]"