Skip to contents

Summarise a multi-segment chain as a data frame

Source: R/segments.R
ok_segment_summary.Rd

Converts the list output of ok_segment_chain() into a tidy data frame with one row per segment, suitable for plotting or reporting.

Usage

ok_segment_summary(chain_result)

Arguments

chain_result

Named list of okBATHTUB objects returned by ok_segment_chain().

Value

A data frame with one row per segment containing key water quality predictions and TSI values.