setlfunit {lfstat}

Define the unit to use in low flow plots

Description

Sets the option for the unit in plots.

Usage

setlfunit(string = "")

Arguments

string

String of the unit

Details

The unit string should be readable for the R-function expression, for common units see example below.

Value

No return value, called for side effects. For the current R session a unit for discharges is set.

Warning

No calculation on data is done by setting this string.

Author(s)

Daniel Koffler and Gregor Laaha

References

Gustard, A. & Demuth, S. (2009) (Eds) Manual on Low-flow Estimation and Prediction. Operational Hydrology Report No. 50, WNO-No. 1029, 136p.

Examples

data(ngaruroro)
# Default: no unit
bfplot(ngaruroro, year = 1991)

# The plot does not change, just the y-label does!
setlfunit("m^3/s")
bfplot(ngaruroro,year = 1991)

# Some possible labels:
setlfunit("m^3/s")
setlfunit("m^{3}*s^{-1}")
setlfunit("scriptscriptstyle(frac(m^3,s))")
setlfunit("l/s")
setlfunit("l*s^{-1}")
setlfunit("scriptscriptstyle(frac(l,s))")
setlfunit("m^3/s/km^2")
setlfunit("m^3*s^{-1}*km^{-2}")
setlfunit("scriptscriptstyle(frac(m^3,s%.%km^2))")
setlfunit("l/s/km^2")
setlfunit("l*s^{-1}*km^{-2}")
setlfunit("scriptscriptstyle(frac(l,s%.%km^2))")