clearCacheEventsOnly: Convenience wrapper around 'clearCache' for SpaDES events

In SpaDES.core: Core Utilities for Developing and Running Spatially Explicit Discrete Event Models

Convenience wrapper around clearCache for SpaDES events

Description

This will clear only the event- and module-level caching that is triggered using a module parameter, .useCache.

Usage

clearCacheEventsOnly(
  ask = TRUE,
  x = getOption("reproducible.cachePath"),
  dryRun = FALSE,
  verbose = getOption("reproducible.verbose")
)

Arguments

ask	Logical. If FALSE, then it will not ask to confirm deletions using clearCache or keepCache. Default is TRUE
x	A simList or a directory containing a valid Cache repository. Note: For compatibility with Cache argument, cachePath can also be used instead of x, though x will take precedence.
dryRun	logical. If FALSE, the default, then the function will deleted entries in the Cache. If TRUE, the function will identify which events and .inputObjects will be deleted, without deleting them.
verbose	Numeric, -1 silent (where possible), 0 being very quiet, 1 showing more messaging, 2 being more messaging, etc. Default is 1. Above 3 will output much more information about the internals of Caching, which may help diagnose Caching challenges. Can set globally with an option, e.g., ⁠options('reproducible.verbose' = 0) to reduce to minimal⁠

Value

A list of individual clearCache outputs, one for each event that was cleared.

SpaDES.core documentation built on Jan. 11, 2026, 9:06 a.m.