downloadRSet: Download a RadioSet object

View source: R/downloadRSet.R

downloadRSetR Documentation

Download a RadioSet object

Description

This function allows you to download a RadioSet object for use with this package. The RadioSets have been extensively curated and organized within a PharacoSet class, enabling use with all the analysis tools provided in PharmacoGx.

Usage

downloadRSet(
  name,
  saveDir = tempdir(),
  rSetFileName = NULL,
  verbose = TRUE,
  timeout = 600
)

Arguments

name

Character string, the name of the PhamracoSet to download.

saveDir

Character string with the folder path where the RadioSet should be saved. Defaults to './rSets/'. Will create directory if it does not exist.

rSetFileName

character string, the file name to save the dataset under

verbose

bool Should status messages be printed during download. Defaults to TRUE.

timeout

'numeric(1)' How long to wait before erroring due to timeout, in seconds. Default it 600s (10 minutes).

Value

A rSet object with the dataset, downloaded from our server

Examples

if (interactive()) {
cleveland <- downloadRSet("Cleveland")
}


bhklab/RadioGx documentation built on Oct. 6, 2023, 8:27 a.m.