getRDS {BayesSpace} | R Documentation

## Download a processed sample from our S3 bucket

### Description

Datasets are cached locally using `BiocFileCache`. The first time using this function, you may need to consent to creating a BiocFileCache directory if one does not already exist.

### Usage

    getRDS(dataset, sample, cache = TRUE)

### Arguments

`dataset` | Dataset identifier
`sample` | Sample identifier
`cache` | If true, cache the dataset locally with `BiocFileCache`. Otherwise, download directly from our S3 bucket. Caching saves time on subsequent loads, but consumes disk space.

### Value

sce A SingleCellExperiment with positional information in colData and PCs based on the top 2000 HVGs

### Examples

    sce <- getRDS("2018_thrane_melanoma", "ST_mel1_rep2", cache=FALSE)

[Package BayesSpace version 1.2.1 Index]