module BioTCM::Databases::Medline::EUtilities
Module wrapper for E-utilities operations
About E-utilities¶ ↑
{www.ncbi.nlm.nih.gov/books/NBK25500/ The Entrez Programming Utilities (E-utilities)} are a set of nine server-side programs that provide a stable interface into the Entrez query and database system at the National Center for Biotechnology Information (NCBI). The E-utilities use a fixed URL syntax that translates a standard set of input parameters into the values necessary for various NCBI software components to search for and retrieve the requested data. The E-utilities are therefore the structured interface to the Entrez system, which currently includes 38 databases covering a variety of biomedical data, including nucleotide and protein sequences, gene records, three-dimensional molecular structures, and the biomedical literature.
Copyright & Disclaimer¶ ↑
Public Instance Methods
EFetch (data record downloads)
Responds to a list of UIDs in a given database with the corresponding data records in a specified format.
@param params [Hash] parameters to be passed to the server @return [String] returned XML from PubMed @option params :db [String] database @option params :rettype [String] return type @option params :retmode [String] return mode @option params :retstart [String] return start @option params :retmax [String] return max @option params :query_key [String] query key used @option params :webenv [String] web environment used
# File lib/biotcm/databases/medline/e_utilities.rb, line 50 def efetch(params) BioTCM.curl('https://eutils.ncbi.nlm.nih.gov/entrez/eutils/efetch.fcgi', params: params) end
ESearch (text searches)
Responds to a text query with the list of matching UIDs in a given database (for later use in ESummary, EFetch or ELink), along with the term translations of the query.
@param params [Hash] parameters to be passed to the server @return [String] returned XML from PubMed @option params :db [String] database @option params :term [String] term @option params :webenv [String] web environment used @option params :usehistory [āyā or ānā] ('y') whether to use history server
# File lib/biotcm/databases/medline/e_utilities.rb, line 33 def esearch(params) BioTCM.curl('https://eutils.ncbi.nlm.nih.gov/entrez/eutils/esearch.fcgi', params: params) end