einfo: einfo

In gschofl/rentrez: An R interface to the NCBI EUtilities

Description

“einfo” is a virtual S4 class that is extended by the einfoDbList, and einfoDb classes.

einfo retrieves information about each database in the NCBI Entrez system. If no database is specified einfo will return a list of currently available NCBI databases. For specific databases, einfo returns the name, a description, the number of records indexed in the database, the date of the last update of the database, the fields and the available links from the database to other Entrez databases.

Usage

  einfo(db)

Arguments

db	A valid NCBI database name. If missing a list of all current NCBI databases is returned.

Details

See the documentation for the NCBI EUtilities for additional information.

Value

An einfo instance.

Class hierarchy for einfo

Sub classes:

• einfoDbList

• einfoDb

Super classes:

• eutil

Generics with methods for einfo

• [* (1 methods defined for subclasses)

• content

• dbName

• description* (1 methods defined for subclasses)

• fields* (1 methods defined for subclasses)

• lastUpdate* (1 methods defined for subclasses)

• links* (1 methods defined for subclasses)

• menuName* (1 methods defined for subclasses)

• records* (1 methods defined for subclasses)

• show

* = methods only defined for subclasses

Examples

## get database statistics and search fields

# a list of all valid Entrez databases
databases <- einfo()
databases

# database statistics for protein
protein <- einfo("protein")
protein

# retrieve xml response
p <- content(protein, "xml")
p

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