rvn_write_Raven_label: Writes common Raven labeled line to file, with optional value...

In rchlumsk/RavenR: Raven Hydrological Modelling Framework R Support and Analysis

Writes common Raven labeled line to file, with optional value (appends)

Description

Writes common Raven labeled line to file, with optional value (appends)

Usage

rvn_write_Raven_label(
  label,
  filename,
  value = NULL,
  digits = NULL,
  indent_level = 0
)

Arguments

label	character, (e.g. "SoilClasses")
filename	character, file name/path to write to, with extension
value	numeric or character, corresponding value written after label (optional)
digits	Number of digits to round value to (optional)
indent_level	Adds two spaces before label for every one level (default = 0)

Value

TRUE	returns TRUE if executed successfully

Author(s)

Leland Scantlebury, [e-mail]

Examples

tf <- file.path(tempdir(), "Hogwarts.rvi")

# Numeric example
rvn_write_Raven_label('Duration', filename=tf, value=365)

# Hydrologic Processes
rvn_write_Raven_label('HydrologicProcesses', tf)

# String example, with indent
rvn_write_Raven_label('SnowBalance', filename = tf,
                      value = paste('SNOBAL_HMETS', 'MULTIPLE', 'MULTIPLE'),
                      indent_level = 1)

# Preview file
readLines(tf)

rchlumsk/RavenR documentation built on April 19, 2024, 5:15 a.m.