query.run: Run a query instance using any restrictions that have been...

In hms-dbmi/pic-sure-biodatacatalyst-r-adapter-hpds: Simplified R library to communicate with HPDS-hosted services on the BioData Catalyst network

Run a query instance using any restrictions that have been added to it.

Description

Run a query instance using any restrictions that have been added to it.

Usage

query.run(query, result.type = "results", verbose = FALSE)

Arguments

query	A query instance object.
result.type	A string specifying what type of results to return. Possible values: "count", "dataframe", "variantsApproximateCount" and "variantsDataFrame".
verbose	Flag to display additional runtime information.

Details

Description of result.type values

• "count": Single count indicating the number of matching records

• "dataframe": DataFrame containing the matching records

• "variantsApproximateCount": Single estimated count of the number of matching variants

• "variantsDataFrame": DataFrame of the matching variants

#' @param verbose Flag to display additional runtime information.

Examples

# myconn <- picsure::connect(url="http://your.server/PIC-SURE/", token="your-security-token")
# myres <- hpds::get.resource(connection=myconn, resourceUUID="YOUR-UUID-0000")
# myquery <- hpds::new.query(resource=myres)

## ...modify the query by adding search criteria... ##

# results <- hpds::query.run(query=myquery)

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