SS_writeforecast: write forecast file

View source: R/SS_writeforecast.R

SS_writeforecastR Documentation

write forecast file

Description

write Stock Synthesis forecast file from list object in R which was probably created using SS_readforecast()

Usage

SS_writeforecast(
  mylist,
  dir = NULL,
  file = "forecast.ss",
  writeAll = FALSE,
  overwrite = FALSE,
  verbose = TRUE
)

Arguments

mylist

List object created by SS_readforecast().

dir

A file path to the directory of interest. The default value is dir = NULL, which leads to using the current working directory.

file

Filename for new forecast file. Default="forecast.ss".

writeAll

Should the function continue even if Forecast=0 (at which point SS stops reading, and remaining elements in list may not be available, depending on settings used in SS_readforecast)

overwrite

A logical value specifying if the existing file(s) should be overwritten. The default value is overwrite = FALSE.

verbose

A logical value specifying if output should be printed to the screen.

Author(s)

Ian G. Taylor, Kelli F. Johnson, Kathryn L. Doering, Nathan R. Vaughan

See Also

Other read/write functions: SS_read(), SS_readctl(), SS_readdat(), SS_readforecast(), SS_readstarter(), SS_write(), SS_writectl(), SS_writedat(), SS_writestarter()


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