saveAndViewResults-Vision-method: Save the VISION object as an .RDS file and view the results...

In YosefLab/VISION: Functional interpretation of single cell RNA-seq latent manifolds

Save the VISION object as an .RDS file and view the results on a localhost

Description

This is just a convience function wrapping two function calls

Usage

## S4 method for signature 'Vision'
saveAndViewResults(
  object,
  ofile = NULL,
  port = NULL,
  host = NULL,
  browser = TRUE,
  name = NULL
)

Arguments

object	VISION object
ofile	the path to save the object in. If NULL, the object is saved in the working directory [default:NULL]
port	The port on which to serve the output viewer. If omitted, a random port between 8000 and 9999 is chosen.
host	The host used to serve the output viewer. If omitted, "127.0.0.1" is used.
browser	Whether or not to launch the browser automatically (default=TRUE)
name	Name for the sample - is shown at the top of the output report

Details

saveAndViewResults(vis, 'vision_results.rds')

is equivalent to:

saveRDS(vis, 'vision_results.rds') viewResults(vis)

Value

the path of the saved file

Examples

## Not run: 

vis <- Vision(data = expMat, signatures = sigs)

options(mc.cores=10) # Use 10 cores
vis <- analyze(vis)

saveAndViewResults(vis, 'vision_results.rds') # Saves and launches dynamic output report

## End(Not run)

YosefLab/VISION documentation built on June 14, 2024, 5:27 p.m.