downloadTSet: Download a ToxicoSet object

In bhklab/ToxicoGx: Analysis of Large-Scale Toxico-Genomic Data

Download a ToxicoSet object

Description

This function allows you to download a ToxicoSet object for use with this package. The ToxicoSets have been extensively curated and organised within a ToxicoSet class, enabling use with all the analysis tools provided in ToxicoGx.

Usage

downloadTSet(
  name,
  saveDir = tempdir(),
  tSetFileName = 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 ToxicoSet should be saved. Defaults to './tSets/'. Will create directory if it does not exist.
tSetFileName	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 the download times out, in seconds. Default is 600 seconds (10 minutes).

Value

A tSet object with the dataset, downloaded from our server

Examples

if (interactive()) {
drugMatrix_rat <- downloadTSet("DrugMatrix Rat")
}

bhklab/ToxicoGx documentation built on March 18, 2023, 6:44 a.m.