Skip to contents

Prints a formatted summary of all water quality predictions accumulated through the pipeline. Most informative after ok_tsi() has been run.

Usage

# S3 method for class 'okBATHTUB'
summary(object, ...)

Arguments

object

An okBATHTUB object.

...

Ignored.

Value

The okBATHTUB object object, returned invisibly. Called primarily for the side effect of printing a multi-line formatted water quality summary to the console. The summary block includes segment metadata, hydraulic and load fields, in-lake water quality predictions, and Carlson Trophic State Indices, depending on which pipeline steps have been completed on the input object.