dtq_discharge_to_stage: Convert Discharge to Stage

View source: R/discharge-to-stage.R

dtq_discharge_to_stageR Documentation

Convert Discharge to Stage

Description

Convert Discharge to Stage

Usage

dtq_discharge_to_stage(
  x,
  r1d,
  dtt = "DateTime",
  colname = "Discharge",
  stage = "Stage",
  n = 0L,
  rate_down = Inf,
  rate_up = rate_down,
  units = dtt_units(x[[dtt]])
)

Arguments

x

A dts data frame

r1d

A data frame of the discharge and stage values for a transect from a 1-dimensional model.

dtt

A string specifying the column with the Date or POSIXct values.

colname

A character vector specifying the column(s) with the discharge and/or stage data.

stage

A string of the name of the column with the stage values.

n

A count of the number of time units until the stage responds.

rate_down

A positive number of the maximum absolute rate when dropping the discharge.

rate_up

A positive number of the maximum rate when increasing the discharge.

units

A string of the units.

Value

The updated dtq data frame with a stage column.


poissonconsulting/dtq documentation built on March 10, 2024, 8:14 a.m.