LoadBridgeReference: Load the extended reference RDS file for bridge integration

View source: R/helpers.R

LoadBridgeReferenceR Documentation

Load the extended reference RDS file for bridge integration

Description

Read in a precomputed extended reference. This function can read either from URLs or a file path. The function looks for a file called ext.Rds for the extended reference Seurat object

Usage

LoadBridgeReference(path, seconds = 10L)

Arguments

path

Path or URL to the RDS file

seconds

Timeout to check for URLs in seconds

Value

A list with two entries:

map

The extended reference Seurat object

plot

The reference Seurat object (for plotting)

Examples

## Not run: 
# Load from a URL
ref <- LoadBridgeReference("https://seurat.nygenome.org/references/pbmc")
# Load a file from the path to a directory 
ref2 <- LoadBridgeReference("path/")
# Load a file directly
ref3 <- LoadBridgeReference("ext.Rds")

## End(Not run)

satijalab/azimuth documentation built on Nov. 19, 2023, 8:34 a.m.