epost: epost

Description Usage Arguments Details Value Class hierarchy for epost Generics with methods for epost Slots

Description

“epost” is an S4 class that provides a container for data retrived by calls to the NCBI EPost utility.

epost allows to upload a list of UIDs to the Entrez History Server and returns an integer label called a query key and an encoded cookie string called a Web environment. epost instances can then be used in stead of a UID list in subsequent esummary, efetch, or elink calls.

Usage

1
  epost(id, db = NULL, WebEnv = NULL)

Arguments

id

(Required) List of UIDs.

db

(Required) Database containing the UIDs in the input list.

WebEnv

(Optional) Web Environment. If provided, this parameter specifies the Web Environment that will receive the UIDs sent by epost. EPost will create a new query key associated with that Web Environment. The WebEnv value is usually returned by a previous call to esearch, epost or elink. If no WebEnv parameter is provided, EPost will create a new Web Environment and post the UIDs to query_key 1.

Details

See the official online documentation for NCBI's EUtilities for additional information.

Value

An epost instance.

Class hierarchy for epost

Super classes:

Generics with methods for epost

Slots

url

A character vector containing the query URL.

error

Any error or warning messages parsed from the output of the call submitted to Entrez.

content

A character vector holding the unparsed contents of a request to Entrez.

database

The number of items posted.

count

The index of the first hit retrieved.

queryKey

Integer label called query key, specifying the location on the Entrez history server of the list of UIDs matching the Entrez query.

webEnv

Encoded cookie string called a Web environment, specifying the location on the Entrez history server of the list of UIDs matching the Entrez query.


gschofl/rentrez documentation built on May 17, 2019, 8:53 a.m.