Report Variable Definition

Report variable definition for argument variables of setReportOptions

Usage

reportVariable(
  name = "Elevation",
  yes = TRUE,
  below = NA,
  above = NA,
  precision = 2
)

Arguments

name

name of variable. Node variables that can be reported on include: "Elevation", "Demand", "Head", "Pressure", "Quality". Link variables include: "Length", "Diameter", "Flow", "Velocity", "Headloss", "LinkQuality", "LinkStatus", "Setting" (Roughness for pipes, speed for pumps,, pressure/flow setting for valves), "Reaction" (reaction rate), "FFactor" (friction factor)

yes

shall the variable be importet on?

below

if set to a non-NA value (default: NA) only values below the given value will be reported on

above

if set to a non-NA value (default: NA) only values above the given value will be reported on

precision

the variable will be reported on with the given precision (number of decimal places). Default: 2