PicSureHpdsDictionaryBdcResult: PicSureHpdsDictionaryBdcResult

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

PicSureHpdsDictionaryBdcResult

Description

R6 class contain the results of a search against a HPDS resource's data dictionary - 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.

Methods

Public methods

• PicSureHpdsDictionaryBdcResult$new()

• PicSureHpdsDictionaryBdcResult$count()

• PicSureHpdsDictionaryBdcResult$entries()

• PicSureHpdsDictionaryBdcResult$varInfo()

• PicSureHpdsDictionaryBdcResult$paths()

• PicSureHpdsDictionaryBdcResult$dataframe()

• PicSureHpdsDictionaryBdcResult$clone()

---

Method new()

This method is used to create a PicSureHpdsDictionaryBdcResult object. DO NOT CREATE THIS OBJECT DIRECTLY!

Usage

PicSureHpdsDictionaryBdcResult$new(results, scopes, showAll = FALSE)

Arguments

results

A list of results to process and return.

scopes

A list of query scopes for filter by.

showAll

Show all studies, not just ones within connection query scopes.

---

Method count()

This method returns a integer of how many terms were returned by the data dictionary search.

Usage

PicSureHpdsDictionaryBdcResult$count()

Returns

Return the number of returned results.

---

Method entries()

This method returns information about the terms discovered by the data dictionary search in a data frame format.

Usage

PicSureHpdsDictionaryBdcResult$entries()

Returns

Return all results.

---

Method varInfo()

Display all information available on a particular HPDS_PATH corresponding to a search result.

Usage

PicSureHpdsDictionaryBdcResult$varInfo(path)

Arguments

path

A path to look for in the results.

Returns

A data.frame containing the fields for the given path.

---

Method paths()

Extract the paths of all results into a list.

Usage

PicSureHpdsDictionaryBdcResult$paths()

Returns

A list of paths returned from the results.

---

Method dataframe()

Flatten the results into a data.frame.

Usage

PicSureHpdsDictionaryBdcResult$dataframe()

Returns

A data.frame of all results.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

PicSureHpdsDictionaryBdcResult$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.