tidywater (version 0.7.0)

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

Value

A knitr_kable table of specified water quality parameters.

Arguments

water

Source water vector created by define_water.

params

List of water quality parameters to be summarized. Options include "general", "ions", "corrosion", and "dbps". Defaults to "general" only.

Details

Use calculate_corrosion for corrosivity indicators and chemdose_dbp for modeled DBP concentrations.

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