Run simInit and experiment in one step — simInitAndExperiment • SpaDES.project

Run simInit and experiment in one step

simInitAndExperiment(
  times,
  params,
  modules,
  objects,
  paths,
  inputs,
  outputs,
  loadOrder,
  notOlderThan,
  replicates,
  dirPrefix,
  substrLength,
  saveExperiment,
  experimentFile,
  clearSimEnv,
  cl,
  ...
)

Arguments

times, paths, outputs, loadOrder: Passed to SpaDES.core::simInit(); see there.
params: Like for SpaDES.core::simInit(), but for each parameter, provide a list of alternative values.
modules: Like for SpaDES.core::simInit(), but a list of module names (as strings).
objects: Like for SpaDES.core::simInit(), but a list of named lists of named objects.
inputs: Like for SpaDES.core::simInit(), but a list of inputs data.frames.
notOlderThan: Currently unused (kept for back-compatibility).
replicates: The number of replicates to run of the same simList.
dirPrefix: String vector. This will be concatenated as a prefix on the directory names.
substrLength: Numeric. While making outputPath for each spades call, this is the number of characters kept from each factor level.
saveExperiment: Logical. Should the resulting experimental design be saved to a file. Default TRUE.
experimentFile: String. Filename if saveExperiment is TRUE; saved to outputPath(sim) in .RData format.
clearSimEnv: Logical. If TRUE, then the envir(sim) of each simList in the return is emptied, to reduce RAM load. Default FALSE.
cl: Deprecated and ignored; control parallelism with future::plan().
...: Passed to experiment2() and onward to SpaDES.core::spades() (e.g. debug, .plotInitialTime, cache, and events – see Controlling events in experiment2()).

Details

simInitAndExperiment cannot pass modules or params to experiment because these are also in simInit. If the experiment is being used to vary these arguments, it must be done separately (i.e., simInit then experiment).

Moved here from the now-unmaintained SpaDES.experiment package.