Skip to contents

CellSight ships four large refGene gene-annotation GTF files (hg19, hg38, mm9, mm10) that are used to build the gene index for ATAC track plots. To keep the installed package small, these files are hosted as release assets and downloaded on demand the first time they are needed. Downloads are cached with BiocFileCache so each file is fetched only once and reused on subsequent calls.

Usage

getRefGeneGTF(scGenome, cache = refGeneCache(), verbose = TRUE)

Arguments

scGenome

character scalar naming the genome build. One of "hg19", "hg38", "mm9", "mm10".

cache

optional BiocFileCache object. Defaults to a persistent package-specific cache under tools::R_user_dir("cellsight", "cache").

verbose

logical; emit a message when a file is downloaded. Default TRUE.

Value

A length-one character vector giving the local filesystem path to the (cached) *.refGene.gtf.gz file.

Details

All four files are hosted as release assets on the datav1.0.0 data release of the CellSight repository.

Examples

# \donttest{
# Downloads a real file from the network; skipped during routine checks.
gtf <- getRefGeneGTF("hg38")
file.exists(gtf)
# }