summarize_wq {tidywater} | R Documentation |
Create summary table from water class
Description
This function takes a water data frame defined by define_water
and outputs a formatted summary table of
specified water quality parameters.
summarise_wq()
and summarize_wq()
are synonyms.
Usage
summarize_wq(water, params = c("general"))
summarise_wq(water, params = c("general"))
Arguments
water |
Source water vector created by |
params |
List of water quality parameters to be summarized. Options include "general", "ions", and "dbps". Defaults to "general" only. |
Details
Use chemdose_dbp
for modeled DBP concentrations.
Value
A knitr_kable table of specified water quality parameters.
Examples
# Summarize general parameters
water_defined <- define_water(7, 20, 50, 100, 80, 10, 10, 10, 10, tot_po4 = 1)
summarize_wq(water_defined)
# Summarize major cations and anions
summarize_wq(water_defined, params = list("ions"))
[Package tidywater version 0.9.0 Index]