run-methods: S4 generic method to run a simulation

In DSsim: Distance Sampling Simulations

Description

Runs the simulation and returns the simulation object with results. If running in parallel and max.cores is not specified it will default to using one less than the number of cores / threads on your machine.

Usage

run(object, run.parallel = FALSE, max.cores = NA, ...)

## S4 method for signature 'Simulation'
run(
  object,
  run.parallel = FALSE,
  max.cores = NA,
  save.data = FALSE,
  load.data = FALSE,
  data.path = character(0),
  counter = TRUE,
  progress.file = ""
)

Arguments

object	an object of class Simulation
run.parallel	logical option to use multiple processors
max.cores	integer maximum number of cores to use, if not specified then one less than the number available will be used.
...	allows the five previous optional arguments to be specified
save.data	logical allows the datasets from the simulation to be saved to file
load.data	logical allows the datasets to be loaded from file rather than simulated afresh.
data.path	character file path to the data files.
counter	logical can be used to turn off simulation counter when running in serial.
progress.file	character file to output progress to for Distance for Windows

Value

an object of class simulation which now includes the results

See Also

make.simulation

DSsim documentation built on March 26, 2020, 7:39 p.m.