read_cache: Read R Objects from Cache
In jianhaizhang/spatialHeatmap: spatialHeatmap

read_cache

R Documentation

Read R Objects from Cache

Description

Read R Objects from Cache

Usage

read_cache(dir, name, info = FALSE)

Arguments

`dir`	The directory path where cached data are located. It should be the path returned by save_cache.
`name`	The name of the object to retrieve, which is one of the entries in the "rname" column returned by setting `info=TRUE`.
`info`	Logical, TRUE or FALSE. If TRUE (default), the information of all tracked files in cache is returned in a table.

Value

An R object retrieved from the cache.

Author(s)

Jianhai Zhang jzhan067@ucr.edu
Dr. Thomas Girke thomas.girke@ucr.edu

References

Lori Shepherd and Martin Morgan (2020). BiocFileCache: Manage Files Across Sessions. R package version 1.12.1.

Examples

# Save the object "iris" in the default cache "~/.cache/shm".
cache.pa <- save_cache(dir=NULL, overwrite=TRUE, iris)
# Retrieve "iris".
iris1 <- read_cache(cache.pa, 'iris')

jianhaizhang/spatialHeatmap documentation built on July 31, 2024, 2:59 a.m.