nf_natsalt_names: Get vector of natural flow and salt gage names, filenames,...

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

Get vector of natural flow and salt gage names, filenames, and abbreviations

Description

These functions return the natural flow and salt file names (nf_file_names() and natsalt_file_names()), the natural flow gage names (nf_gage_names()), and the abbreviations (nf_gage_abbrv()) of the natural flow gage names in the standard node order used by Reclamation and expected by CRSS.

Usage

nf_file_names(version = 5)

natsalt_file_names(version = 5)

nf_gage_names()

nf_gage_abbrv()

Arguments

version

The CRSS version number. Current version of CRSS is 6. Valid versions are 1-6.

Details

nf_file_names() and natsalt_file_names() return file names that CRSS is expecting to read in for natural flow and salt input data.

nf_gage_names() returns a vector with the USGS gage names used by CRSS corresponding to the natural flow basins. The order matches the node order used by Reclamation and CRSS and thus should not be modified.

nf_gage_abbrv() returns an abbreviated shorthand name for the natural flow gages/nodes, because it is it is desirable to have shorthand names for many purposes, i.e., variable names.

Value

Vector of characters with 29 entries (file names, gage names, gage abbreviations).

See Also

crssi_create_dnf_files

Examples

fileNames <- nf_file_names()
## Not run: 
iFiles <- 'NaturalFlows1906-2012_withExtensions_1.8.15.xlsx'
crssi_create_dnf_files(iFile,'NFSinput/','2015-1-31',50,fileNames)

## End(Not run)

# get the gage name for node 20 
nf_gage_names()[20]
# and its shorthand name
nf_gage_abbrv()[20]
# and then see the CRSS natural inflow file name corresponding to this gage
nf_file_names()[20]

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