summary.aedseo {aedseo}R Documentation

Summary method for aedseo objects

Description

[Stable]

Summarize the results of an aedseo analysis, including the latest growth rate estimate, the confidence interval, and information about growth warnings.

Usage

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

Arguments

object

An object of class 'aedseo' containing the results of an aedseo 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 tsibble object from sample data
tsd_data <- tsd(
  observed = c(100, 120, 150, 180, 220, 270),
  time = as.Date(c(
    "2023-01-01",
    "2023-01-02",
    "2023-01-03",
    "2023-01-04",
    "2023-01-05",
    "2023-01-06"
  )),
  time_interval = "day"
)

# Calculate aedseo with a 3-day window and a Poisson family model
aedseo_results <- aedseo(
  tsd = tsd_data,
  k = 3,
  level = 0.95,
  family = "poisson"
)
# Print the summary of the aedseo_results to the console
summary(aedseo_results)

[Package aedseo version 0.1.2 Index]