cache.ok: Check Cache Status

In oliver-wyman-actuarial/easyR: Helpful Functions from Oliver Wyman Actuarial Consulting

Check Cache Status

Description

Check a cache and if necessary clear it to trigger a re-cache.

Usage

cache.ok(cache.num, do.load = TRUE)

Arguments

cache.num	The index/number for the cache we are checking in the cache.info list.
do.load	Load the cache if it is found.

Value

Boolean indicating if the cache is acceptable. FALSE indicates the cache doesn't exist or is invalid so code should be run again.

Examples

# check the first cache to see if it exists and dependent files haven't changed.
# if this is TRUE, code in brackets will get skipped and the cache will be loaded instead.
# set do.load = FALSE if you have multiple files that build a cache, 
#    to prevent multiple cache loads.
# output will be printed to the console to tell you if the cache was loaded or re-built.
## Not run: 
  if( ! cache.ok(1) ){

    # do stuff
  
    # if this is the final file for this cache, 
    #   end with save.cache to save passed objects as a cache.
    save.cache(iris)
  }

## End(Not run)

oliver-wyman-actuarial/easyR documentation built on Jan. 27, 2024, 4:35 a.m.