downloadUMI4CexampleData: Download UMI4Cats example datasets

Description Usage Arguments Value Examples

View source: R/downloadUMI4CexampleData.R

Description

Downloads the required UMI4Cats example datasets.

Usage

1
downloadUMI4CexampleData(out_dir = tempdir(), verbose = TRUE, reduced = FALSE)

Arguments

out_dir

Output directory for the datasets, defaults to tempdir().

verbose

Whether to print verbose messages or not. Default: TRUE.

reduced

Whether to use a reduced dataset to make test functions run faster.

Value

It creates the output_dir with the example UMI-4C files used by the vignette and examples. Takes advantage of the BiocFileCache package to make sure that the file has not been previously downloaded by the user.

Examples

1
2
3
4
5
6
7
if (interactive()) {
 # Using reduced data data to make example faster.
# Remove reduced=TRUE or set to FALSE to
# download the full dataset.

path <- downloadUMI4CexampleData(reduced = TRUE)
}

UMI4Cats documentation built on Dec. 31, 2020, 2:01 a.m.