summary.tsd_burden_levels: Summary method for 'tsd_burden_levels' objects

View source: R/summary.R

summary.tsd_burden_levelsR Documentation

Summary method for tsd_burden_levels objects

Description

Summarize key results from a seasonal burden levels analysis.

Usage

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

Arguments

object

An object of class 'tsd_burden_levels' containing the results of a seasonal_burden_levels analysis.

...

Additional arguments (not used).

Value

This function is used for its side effect, which is printing the burden levels.

Examples

# Create a `tsd` object
tsd_data <- generate_seasonal_data()

# Create a `tsd_burden_levels` object
tsd_burden_levels <- seasonal_burden_levels(
  tsd = tsd_data
)
# Print the summary
summary(tsd_burden_levels)

aedseo documentation built on April 12, 2025, 1:35 a.m.