madrat (version 3.15.6)

cacheName: Tool: cacheName

Description

Load fitting cache data (if available)

Usage

cacheName(
  prefix,
  type,
  args = NULL,
  graph = NULL,
  mode = "put",
  packages = getConfig("packages"),
  globalenv = getConfig("globalenv")
)

Value

Name of fitting cache file, if available, otherwise NULL

Arguments

prefix

function prefix (e.g. "calc" or "read")

type

output type (e.g. "TauTotal")

args

a list of named arguments used to call the given function

graph

A madrat graph as returned by getMadratGraph. Will be created with getMadratGraph if not provided.

mode

Context in which the function is used. Either "get" (loading) or "put" (writing). In case of "put" the potential file name is returned. When set to "get", a file name will only be returned if the file exists (otherwise NULL) and in combination which setConfig(forcecache=TRUE) even a cache file with deviating hash might get selected.

packages

A character vector with packages for which the available Sources/Calculations should be returned

globalenv

Boolean deciding whether sources/calculations in the global environment should be included or not

Author

Jan Philipp Dietrich

See Also

cachePut, cacheName

Examples

madrat:::cacheName("calc", "TauTotal")