get_dataset_samples: Retrieve the samples of a dataset

In jsicherman/GemmAPI: A wrapper for Gemma's Restful API to access curated gene expression data and differential expression analyses

Retrieve the samples of a dataset

Description

Retrieve the samples of a dataset

Usage

get_dataset_samples(
  dataset,
  raw = getOption("gemma.raw", FALSE),
  memoised = getOption("gemma.memoised", FALSE),
  file = getOption("gemma.file", NA_character_),
  overwrite = getOption("gemma.overwrite", FALSE)
)

Arguments

dataset	A numerical dataset identifier or a dataset short name
raw	TRUE to receive results as-is from Gemma, or FALSE to enable parsing. Raw results usually contain additional fields and flags that are omitted in the parsed results.
memoised	Whether or not to save to cache for future calls with the same inputs and use the result saved in cache if a result is already saved. Doing options(gemma.memoised = TRUE) will ensure that the cache is always used. Use forget_gemma_memoised to clear the cache.
file	The name of a file to save the results to, or NULL to not write results to a file. If raw == TRUE, the output will be the raw endpoint from the API, likely a JSON or a gzip file. Otherwise, it will be a RDS file.
overwrite	Whether or not to overwrite if a file exists at the specified filename.

Value

A data table with information about the samples of the queried dataset. A list if raw = TRUE. A 404 error if the given identifier does not map to any object.

The fields of the output data.table are:

• sample.name: Internal name given to the sample.

• sample.ID: Internal ID of the sample

• sample.description: Free text description of the sample

• sample.outlier: Whether or not the sample is marked as an outlier

• sample.accession: Accession ID of the sample in it's original database

• sample.database: Database of origin for the sample

• sample.characteristics: Characteristics of the sample. This field is a data table

• sample.factorValues: Experimental factor values of the sample. This field is a data table

Examples

head(get_dataset_samples("GSE2018"))

jsicherman/GemmAPI documentation built on Oct. 25, 2024, 5:17 p.m.