SaveAzimuthReference: Save 'Azimuth' references and neighbors index to same folder

In satijalab/azimuth: A Shiny App Demonstrating a Query-Reference Mapping Algorithm for Single-Cell Data

Save Azimuth references and neighbors index to same folder

Description

Save Azimuth references and neighbors index to same folder

Usage

SaveAzimuthReference(object = NULL, folder = NULL)

Arguments

object	An Azimuth reference
file	Path to save Azimuth reference to; defaults to file.path(getwd(), "azimuth_reference/"))
...	Arguments passed on to base::saveRDS ascii a logical. If TRUE or NA, an ASCII representation is written; otherwise (default), a binary one is used. See the comments in the help for save. version the workspace format version to use. NULL specifies the current default version (3). The only other supported value is 2, the default from R 1.4.0 to R 3.5.0. compress a logical specifying whether saving to a named file is to use "gzip" compression, or one of "gzip", "bzip2" or "xz" to indicate the type of compression to be used. Ignored if file is a connection. refhook a hook function for handling reference objects.

Value

Invisibly returns file

See Also

saveRDS() readRDS()

Examples

# Make Azimuth Reference object
obj.azimuth <- AzimuthReference(object)

# Save 
SaveAzimuthReference(object = obj.azimuth, folder = "azimuth_reference")

# Run Azimuth

query <- RunAzimuth(query = query, 
                    reference = "azimuth_reference", 
                    ...)

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