bfcif: bfcif

In FrietzeLabUVM/ssvQC: QC for enrichment based NGS

bfcif

Description

Conditionally runs a function if it's results don't exist in the cache. Cache is controlled by BiocFileCache.

Usage

bfcif(
  bfc,
  rname,
  FUN,
  version = getOption("SQC_CACHE_VERSION", "v4"),
  force_overwrite = getOption("SQC_FORCE_CACHE_OVERWRITE", FALSE),
  return_path_only = FALSE,
  verbose = getOption("SQC_CACHE_VERBOSE", FALSE)
)

Arguments

bfc	A BiocFileCache object, typically from BiocFileCache::BiocFileCache().
rname	The unique identifier for the results in the cache. The recommendation is to use either a unique and meaningful description or digest::digest() on a list containing FUN and it's parameters.
FUN	A function that takes zero arguments. This function can be a wrapper around other functions; ie. FUN = function()mean(x).
version	A version indicator string to further distinguish cache entries. Typically, you want to iterate this value when code outside of FUN or input parameters have changed and you want to force FUN to reevaluate. Default is SQC_CACHE_VERSION option or v3 if option is not set.
force_overwrite	If TRUE, FUN will be rerun regardless of cache state. If it exists, current cache contents will be overwritten. Default is SQC_FORCE_CACHE_OVERWRITE option or FALSE if option is not set.
return_path_only	If TRUE, FUN will not be run and instead the cache path is returned. Default is FALSE.
verbose	If TRUE, status is reported via messages. Default is value of SQC_CACHE_VERBOSE option or FALSE if option not set.

Value

Result of FUN, from cache if available.

Examples

bfc = BiocFileCache::BiocFileCache()
bfcif(bfc, "test1", function(x)mean(seq(10)), verbose = TRUE)
bfcif(bfc, "test1", function(x)mean(seq(10)), verbose = TRUE, 
  return_path_only = TRUE)
bfcif(bfc, "test1", function(x)mean(seq(10)), verbose = TRUE, 
  force_overwrite = TRUE)

FrietzeLabUVM/ssvQC documentation built on March 25, 2024, 12:24 a.m.