find.in.dictionary: Search the data dictionary of a PIC-SURE resource.

View source: R/bdc.R

find.in.dictionaryR Documentation

Search the data dictionary of a PIC-SURE resource.

Description

Search the data dictionary of a PIC-SURE resource.

Usage

find.in.dictionary(resource, term = "", limit = 0, offset = 0, verbose = FALSE)

Arguments

resource

A PIC-SURE resource object.

term

A string to search for in the resource's data dictionary. By default, if no term is provided, the whole dictionary will be returned.

limit

A limit of return results.

offset

An offset to start retrning values from.

verbose

Flag to display additional runtime information.

Value

An object representing the search results.

Examples


# myconn <- picsure::connect(url="http://your.server/PIC-SURE/", token="your-security-token")
# myres <- hpds::get.resource(connection=myconn, resourceUUID="YOUR-UUID-0000")
# asthma.terms <- hpds::find.in.dictionary(resource=myres, term="asthma")


hms-dbmi/pic-sure-biodatacatalyst-r-adapter-hpds documentation built on Sept. 24, 2022, 9:24 a.m.