write_crssi: Create CRSS Input Trace Files

In BoulderCodeHub/CRSSIO: Package to Manage the Input and Output of CRSS Data

Create CRSS Input Trace Files

Description

write_crssi() creates the required CRSS input files from a crssi object. In addition to the files for the 29 natural flow inputs (specified by file_names), four additional files are written for each trace. See Details for a description of these slots. The files are formatted and saved in a format expected by CRSS.

Usage

write_crssi(
  x,
  path,
  file_names = nf_file_names(),
  overwrite = FALSE,
  readme = TRUE
)

Arguments

x	crssi object.
path	Directory to save files to.
file_names	The file names that will be used for each natural flow site. See nf_file_names().
overwrite	Boolean. If TRUE and files already exists in path/traceN, the files will be overwritten.
readme	Boolean. If TRUE also create a README file in path.

Details

The four additional slots are:

• Trace number: The trace numbers are intuitive, i.e., they are integers from 1 to N where N is the trace number.

• Scenario number: The scenario number provides the user with a numeric representation of which supply scenario is used. See the Scenario Numbering Convention section in crssi or the package's wiki for details on the scenario number.

• "Hydrology increment" number: The hydrology increment data sets the random number generator in CRSS. This seed value for each year and trace is created for each trace folder.

• Sacramento year type index: The Sacramento Year type index for each year and trace (stored in the crssi object.) See crssi.

See CRSSIO for a description of the package options that determine these slots' file names.

BoulderCodeHub/CRSSIO documentation built on July 2, 2023, 5:15 p.m.