EPM_esearch_parse: Parse Responses from the NCBI ESearch Server.

View source: R/epm_all_fx.R

EPM_esearch_parseR Documentation

Parse Responses from the NCBI ESearch Server.

Description

Parse Responses from the NCBI ESearch Server and return a list of information that can be used for retrieving PubMed records from the NCBI EFetch Server.

Usage

EPM_esearch_parse(x)

Arguments

x

String (character vector of length 1), this is the xml string returned by the NCBI ESearch Server.

Details

The output list includes the following items.

  • 'web_env'. String, unique identifier for fetching PubMed records corresponding to the current query.

  • 'query_key'. Integer, unique numeric key for fetching PubMed records corresponding to the current query.

  • 'count'. Integer, expected number of records returned by the current query.

  • 'query_translation'. String, translation of the Query string provided by the user.

Value

List including information extracted from the NCBI ESearch Server response.

Author(s)

Damiano Fantini, damiano.fantini@gmail.com

References

https://www.data-pulse.com/dev_site/easypubmed/

Examples

# Note: a time limit can be set in order to kill the operation when/if 
# the NCBI/Entrez server becomes unresponsive.
setTimeLimit(elapsed = 4.9)
try({
  my_q <- 'easyPubMed'
  my_params <- list(q = my_q)
  x <- easyPubMed:::EPM_esearch_basic_q(params = my_params)
  easyPubMed:::EPM_esearch_parse(x)
}, silent = TRUE)
setTimeLimit(elapsed = Inf)


dami82/easyPubMed documentation built on Jan. 4, 2024, 6:21 a.m.