scmmCache: Manage cache / download directories for study data

In waldronlab/SingleCellMultiModal: Integrating Multi-modal Single Cell Experiment datasets

Manage cache / download directories for study data

Description

Managing data downloads is important to save disk space and re-downloading data files. This can be done effortlessly via the integrated BiocFileCache system.

Usage

scmmCache(...)

setCache(
  directory = tools::R_user_dir("SingleCellMultiModal", "cache"),
  verbose = TRUE,
  ask = interactive()
)

removeCache(accession)

Arguments

...	For scmmCache, arguments passed to setCache
directory	character(1) The file location where the cache is located. Once set, future downloads will go to this folder. See setCache section for details.
verbose	Whether to print descriptive messages
ask	logical(1) (default TRUE when interactive()) Confirm the file location of the cache directory
accession	character(1) A single string indicating the accession number of the study

Value

The directory / option of the cache location

scmmCache

Get the directory location of the cache. It will prompt the user to create a cache if not already created. A specific directory can be used via setCache.

setCache

Specify the directory location of the data cache. By default, it will go into the user's home and package name directory as given by R_user_dir (default: varies by system e.g., for Linux: '$HOME/.cache/R/SingleCellMultiModal').

removeCache

Some files may become corrupt when downloading, this function allows the user to delete the tarball associated with a study number in the cache.

Examples

getOption("scmmCache")
scmmCache()

waldronlab/SingleCellMultiModal documentation built on Nov. 23, 2024, 3:46 p.m.