get_dataset_subset_samples: get_dataset_subset_samples

View source: R/allEndpoints.R

get_dataset_subset_samplesR Documentation

get_dataset_subset_samples

Description

get_dataset_subset_samples

Usage

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

Arguments

subset

integer ID of the subset (eg. as returned by get_dataset_subset_groups).

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

Varies


jsicherman/Gemma-API documentation built on April 17, 2025, 4:17 p.m.