cacheArgumentsHash: Tool: cacheArgumentsHash

In pik-piam/madrat: May All Data be Reproducible and Transparent (MADRaT) *

Tool: cacheArgumentsHash

Description

Calculate hash from given function arguments for given call

Usage

cacheArgumentsHash(functionName, args = NULL, errorOnMismatch = TRUE)

Arguments

functionName	A function name as a string (usually in the form package:::fun, e.g. madrat:::calcTauTotal). Passing a vector of functions is possible, but is only intended for corresponding read/correct/convert functions. If multiple functions in a vector define arguments with the same name but different default values only the default defined in the first function is considered.
args	A list of named arguments used to call the given function(s). If duplicates of arguments exists the first occurrence of the argument will be used.
errorOnMismatch	Whether an error is thrown in case an argument in args is not accepted by functionName.

Value

A hash representing the given arguments hash for the given call. NULL, if no argument deviates from the default argument settings.

Author(s)

Jan Philipp Dietrich

See Also

cachePut, cacheName, getNonDefaultArguments

Examples

madrat:::cacheArgumentsHash("madrat:::readTau", args = list(subtype = "historical"))
madrat:::cacheArgumentsHash("madrat:::readTau", args = list(subtype = "paper"))
functionNames <- c("madrat:::readTau", "madrat:::convertTau")
madrat:::cacheArgumentsHash(functionNames, args = list(subtype = "historical"))

pik-piam/madrat documentation built on July 4, 2025, 4:56 a.m.