Summary method for tsd_onset objects

Summarize key results from a seasonal onset analysis.

Usage

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

Arguments

object

An object of class 'tsd_onset' containing the results of a seasonal_onset analysis.

...

Additional arguments (not used).

Value

This function is used for its side effect, which is printing a summary message to the console.

Examples

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

# Create a `tsd_onset` object
tsd_onset <- seasonal_onset(
  tsd = tsd_data,
  k = 3,
  disease_threshold = 100,
  season_start = 21,
  season_end = 20,
  level = 0.95,
  family = "poisson",
  only_current_season = TRUE
)
# Print the summary
summary(tsd_onset)