downloadPSet: Download a PharmacoSet object

In PharmacoGx: Analysis of Large-Scale Pharmacogenomic Data

Description

This function allows you to download a PharmacoSet object for use with this package. The PharmacoSets have been extensively curated and organised within a PharacoSet class, enabling use with all the analysis tools provided in PharmacoGx. User availablePSets to discover which PSets are available.

Usage

downloadPSet(
  name,
  saveDir = tempdir(),
  pSetFileName = NULL,
  verbose = TRUE,
  timeout = 600
)

Arguments

name	Character string, the name of the PhamracoSet to download. Note that this is not the dataset name, but the PSet name - dataset names are not guaranteed to be unique.
saveDir	Character string with the folder path where the PharmacoSet should be saved. Defaults to 'tempdir()'. Will create directory if it does not exist.
pSetFileName	character string, the file name to save the dataset under
verbose	bool Should status messages be printed during download. Defaults to TRUE.
timeout	numeric Parameter that lets you extend R's default timeout for downloading large files. Defaults for this function to 600.

Value

A PSet object with the dataset

Warning

BREAKING CHANGES - this function now defaults to 'tempdir()' as the download path! You must specify a saveDir or manually save the PSet if you want your download to persist past your current R session.'

Examples

if (interactive()){
downloadPSet("CTRPv2", saveDir=file.path(".", "pSets"))
}

PharmacoGx documentation built on Feb. 28, 2021, 2 a.m.