allTaxa: All taxa

View source: R/ep_taxa.R

allTaxaR Documentation

All taxa

Description

Lists all available taxa.

Usage

allTaxa(
  taxa = NULL,
  file = NULL,
  return = TRUE,
  overwrite = FALSE,
  memoised = FALSE
)

Arguments

taxa

Limits the result to entities with given identifiers.

A list of identifiers, separated by commas (e.g: human, mouse, fly). Identifiers can be the any of the following:

  • taxon ID

  • scientific name

  • common name

  • abbreviation

file

Character. File path. If provided, response will be saved to file

return

Logical. If the response should be returned. Set to false when you only want to save a file

overwrite

Logical. If TRUE, existing files will be overwritten. If FALSE a warning will be thrown and no action is taken.

memoised

Logical. If TRUE a memoised version of the function will be used which is faster for repeated requests. Use forgetGemmaMemoised to clear memory.

Value

List of lists containing experiment object.

Examples

allTaxa()
allTaxa(c('human','mouse'))

oganm/gemmaAPI documentation built on July 23, 2022, 8:26 p.m.