EUtilsSummary: Get summary of NCBI EUtils query

Description Usage Arguments Details Value Author(s) References See Also Examples

View source: R/EUtilsSummary.R

Description

Get summary information on the results of a query for any database of the National Center for Biotechnology Information (NCBI).

Usage

1
EUtilsSummary(query,type="esearch",db="pubmed",url=NULL,encoding="unknown",...)

Arguments

query

string query as given in NCBI search box

type

string indicating type of NCBI Eutility

db

string indicating the NCBI database used in query

url

string of url to bypass query construction

encoding

encoding to be assumed for input strings, see readLines

...

additional limits added to query

Details

Possible E-utilities to supply to type are einfo, esearch, epost, esummary, elink, egquery, espell.

The database name supplied to db can be any valid Entrez database, such as pubmed, protein, nlm, etc.

For further details on available E-utilities and databases visit http://www.ncbi.nlm.nih.gov/books/NBK25499/.

Limits that can be supplied to ... to refine the query include:

reldate Limits search results to be within the specified number of days from current date.
mindate Minimum of date range for search results (examples: 2002; 2002/01/01); must be supplied with maxdate.
maxdate Maximum of date range for search results; must be supplied with mindate.
datetype Which date field to use in setting date limits. Possible choices are edat, Entrez date, which is the date article was added to Entez, or ppdt, the article publication date. Default is edat.
retstart Where in the sequence of returned results to begin retrieving, default is 0.
retmax Maximum number of records to retrieve, default is 1000.

Value

Returns an EUtilsSummary object.

Author(s)

Stephanie Kovalchik [email protected]

References

Summary help:

http://www.ncbi.nlm.nih.gov/books/NBK3827/

MEDLINE/PubMed Field Descriptions

http://www.nlm.nih.gov/bsd/mms/medlineelements.html

See Also

EUtilsQuery

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
# PUBMED QUERY
res <- EUtilsSummary("myeloma[ti] jones[au]", retmax = 10)

res

summary(res)
QueryCount(res)
QueryId(res)
QueryTranslation(res)

# PROTEIN QUERY
res <- EUtilsSummary("C-reactive[ti]",db="protein", retmax = 10)
summary(res)

RISmed documentation built on June 6, 2017, 5:03 p.m.