dtq_pulse: Pulse

In poissonconsulting/dtq: Manipulate Data Frames with Discharge and Stage Time Series

Pulse

Description

Adds a pulse to a discharge or stage time series.

Usage

dtq_pulse(
  x,
  dtt = "DateTime",
  colname = "Discharge",
  start = x[[dtt]][1],
  duration = 1L,
  target = 0,
  rate_down = Inf,
  rate_up = rate_down,
  units = dtt_units(x[[dtt]])
)

Arguments

x	A dts data frame
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.
start	A dtt object of the start time.
duration	A positive integer of the duration.
target	The target discharge.
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.

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