description: Data set description

Description Usage Arguments Value Examples

View source: R/files.R

Description

Return list containing experiment description elements

Usage

1
2
3
4
5
6
7
description(
  technique,
  dataSet,
  dataSetDir = "DataSets",
  internalDir = TRUE,
  ...
)

Arguments

technique

metabolomic technique name

dataSet

data set name

dataSetDir

directory to store local data sets. If internalDir = TRUE this is a directory relative to the library location.

internalDir

Logical, should the directory for storing local data sets be internal to the package location.

...

arguments to pass to downloadDataSet()

Value

A list containing data set descriptors.

Examples

1
2
3
4
5
6
## Not run: 
description(
   techniques()[1],
   dataSets(techniques()[1])[1])

## End(Not run)

metaboData documentation built on Aug. 20, 2021, 5:06 p.m.