downloadUMI4CexampleData {UMI4Cats} | R Documentation

## Download UMI4Cats example datasets

### Description

Downloads the required UMI4Cats example datasets.

### Usage

    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

    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)
    }

[Package UMI4Cats version 1.0.1 Index]