get_gene_locations: Retrieve the physical locations of a given gene

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

Retrieve the physical locations of a given gene

Description

Retrieve the physical locations of a given gene

Usage

get_gene_locations(
  gene,
  raw = getOption("gemma.raw", FALSE),
  memoised = getOption("gemma.memoised", FALSE),
  file = getOption("gemma.file", NA_character_),
  overwrite = getOption("gemma.overwrite", FALSE)
)

Arguments

gene	An ensembl gene identifier which typically starts with ensg or an ncbi gene identifier or an official gene symbol approved by hgnc
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 physical location of the queried gene. 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:

• chromosome: Name of the chromosome the gene is located

• strand: Which strand the gene is located

• nucleotide: Nucleotide number for the gene

• length: Gene length

• taxon.name: Name of the taxon

• taxon.scientific: Scientific name for the taxon

• taxon.ID: Internal ID for the taxon given by Gemma

• taxon.NCBI: NCBI ID for the taxon

• taxon.database.name: Name of the database used in Gemma for the taxon

Examples

get_gene_locations("DYRK1A")
get_gene_locations(1859)

jsicherman/GemmAPI documentation built on Dec. 15, 2024, 8:59 a.m.