Copy simulation template to filename — ffs_copy_template • ffsimulator

Creates a simulation template file with all of the components of ff_simulate, ready for tinkering!

Usage

ffs_copy_template(
  filename = "ff_simulation.R",
  template = c("season", "week"),
  overwrite = NULL
)

Arguments

filename: New file name, defaults to putting "ff_simulation.R" into your current directory
template: choice of template: one of "season" or "week"
overwrite: a logical (or NULL) - overwrite if existing file found?

Value

a success message signalling success/failure.

Examples

# \donttest{

tmp <- tempfile()
ffs_copy_template(tmp)
#> ✔ Successfully copied template to /tmp/Rtmpwf16Qh/file1a447f6a29e3!
# }