copy_SS_inputs: Copy a the Stock Synthesis input files from one directory to...

In r4ss/r4ss: R Code for Stock Synthesis

Copy a the Stock Synthesis input files from one directory to another

Description

Reads the starter.ss file to figure out the names of the control and data files, than copies those files along with starter.ss, forecast.ss, and wtatage.ss (if present) to a new directory, as specified.

Usage

copy_SS_inputs(
  dir.old = NULL,
  dir.new = NULL,
  create.dir = TRUE,
  overwrite = FALSE,
  recursive = FALSE,
  use_ss_new = FALSE,
  copy_exe = FALSE,
  copy_par = FALSE,
  dir.exe = NULL,
  verbose = TRUE
)

Arguments

dir.old	Location of model files to be copied, either an absolute path or relative to the working directory.
dir.new	New location to which the files should be copied, either an absolute path or relative to the working directory.
create.dir	Create dir.new directory if it doesn't exist already?
overwrite	A logical value specifying if the existing file(s) should be overwritten. The default value is overwrite = FALSE.
recursive	A logical value passed to the recursive argument of dir.create() that specifies if elements of the path other than the last be created?
use_ss_new	Use .ss_new files instead of original inputs?
copy_exe	Copy any executables found in dir.old to dir.new or dir.exe (if provided)?
copy_par	Copy any .par files found in dir.old to dir.new?
dir.exe	Path to executable to copy instead of any in dir.old.
verbose	A logical value specifying if output should be printed to the screen.

Value

A logical value is invisibly returned, indicating whether all input files were copied successfully.

Author(s)

Ian G. Taylor

See Also

Other run functions: jitter(), populate_multiple_folders(), profile(), retro(), run(), tune_comps()

Examples

## Not run: 
# A theoretical example if "old_model" was present
# but expect an error
copy_SS_inputs(
  dir.old = "c:/SS/old_model",
  dir.new = "c:/SS/new_model"
)
# A working example using files stored in {r4ss}
copy_SS_inputs(
  dir.old = system.file("extdata", "simple_small", package = "r4ss"),
  dir.new = "test"
)
unlink(test, recursive = TRUE)

## End(Not run)

r4ss/r4ss documentation built on April 30, 2024, 4:42 a.m.