PicSureHpdsQueryBdc: PicSureHpdsQueryBdc

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

PicSureHpdsQueryBdc

Description

R6 class used to build a multi-use query to search against a HPDS resource's data - DO NOT CREATE THIS OBJECT DIRECTLY!

For full documentation of each method go to https://github.com/hms-dbmi/pic-sure-r-adapter-hpds

Value

Object of R6Class used to access a HPDS-hosted resource's data dictionary.

Super class

hpds::PicSureHpdsQuery -> PicSureHpdsQueryBdc

Methods

Public methods

• PicSureHpdsQueryBdc$new()

• PicSureHpdsQueryBdc$buildQuery()

• PicSureHpdsQueryBdc$clone()

Inherited methods

• hpds::PicSureHpdsQuery$anyof()
• hpds::PicSureHpdsQuery$crosscounts()
• hpds::PicSureHpdsQuery$filter()
• hpds::PicSureHpdsQuery$getCount()
• hpds::PicSureHpdsQuery$getResults()
• hpds::PicSureHpdsQuery$getResultsDataFrame()
• hpds::PicSureHpdsQuery$getRunDetails()
• hpds::PicSureHpdsQuery$getVariantsApproximateCount()
• hpds::PicSureHpdsQuery$getVariantsDataFrame()
• hpds::PicSureHpdsQuery$load()
• hpds::PicSureHpdsQuery$loadInternal()
• hpds::PicSureHpdsQuery$require()
• hpds::PicSureHpdsQuery$save()
• hpds::PicSureHpdsQuery$select()
• hpds::PicSureHpdsQuery$show()

---

Method new()

This method is used to create new PicSureHpdsQueryBdc object. DO NOT CREATE THIS OBJECT DIRECTLY!

Usage

PicSureHpdsQueryBdc$new(connection)

Arguments

connection

A bdc::PicSureHpdsResourceConnectionBdc object.

---

Method buildQuery()

Generate a query object and modify consents for harmonized and topmed concept paths.

Usage

PicSureHpdsQueryBdc$buildQuery(resultType = "COUNT")

Arguments

resultType

The type of result that should be returned from the api.

Returns

An object to use for the query.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

PicSureHpdsQueryBdc$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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