GitHub - ssi-dk/aedseo: Automated and Early Detection of Seasonal Epidemic Onset and Burden Levels (original) (raw)

aedseo aedseo website

R-CMD-check Codecov test coverage CRAN status

Description

The Automated and Early Detection of Seasonal Epidemic Onset and Burden Levels (aedseo) package provides a powerful tool for automating the early detection of seasonal epidemic onsets in time series data. It offers the ability to estimate growth rates for consecutive time intervals. With use of the average observations within those intervals and an estimated disease-specific threshold it also offers the possibility to estimate seasonal onset of epidemics. Additionally it offers the ability to estimate burden levels for seasons based on historical data. It is aimed towards epidemiologists, public health professionals, and researchers seeking to identify and respond to seasonal epidemics in a timely fashion.

Installation

Install aedseo from CRAN

install.packages("aedseo")

Development version

You can install the development version of aedseo fromGitHub with:

install.packages("devtools")

devtools::install_github("ssi-dk/aedseo")

Getting started

To quickly get started with aedseo, follow these steps:

  1. Install the package using the code provided above.
  2. Load the package with library(aedseo).
  3. Create a time series data object (tsd) from your data using theto_time_series() function or generate_seasonal_data() functions.
  4. Apply the combined_seasonal_output() function to get a comprehensive seasonal analysis with seasonal onset and burden levels.

Vignette

For a more detailed introduction to the workflow of this package, see the Get Started vignette or run; vignette("aedseo").

Contributing

We welcome contributions to the aedseo package. Feel free to open issues, submit pull requests, or provide feedback to help us improve.