lfstat (version 0.9.12)

setlfunit: Define the unit to use in low flow plots

Description

Sets the option for the unit in plots.

Usage

setlfunit(string = "")

Value

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

Arguments

string

String of the unit

Warning

No calculation on data is done by setting this string.

Author

Daniel Koffler and Gregor Laaha

Details

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

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))")