check_aeddo_inputs {aeddo}R Documentation

Check and assert the inputs for the aeddo function.

Description

This function is for internal use and checks the validity of inputs to the aeddo function. It performs various checks using the checkmate package to ensure that the inputs conform to expected types and values.

Usage

check_aeddo_inputs(
  data,
  formula,
  k,
  sig_level,
  exclude_past_outbreaks,
  init_theta,
  lower,
  upper,
  method
)

Arguments

data

A data frame containing the time series data.

formula

A model formula for the fixed effects in the hierarchical model.

k

An integer specifying the rolling window size employed for parameter estimation.

sig_level

The quantile from the random effects distribution used for defining the outbreak detection threshold.

exclude_past_outbreaks

Logical indicating whether past outbreak-related observations should be excluded from future parameter estimation.

init_theta

Initial values for model parameters in optimization.

lower

Lower bounds for optimization parameters.

upper

Upper bounds for optimization parameters.

method

The optimization method to use, either "BFGS" or "L-BFGS-B".

Value

Returns nothing. Raises errors if the inputs do not meet the specified criteria.

Examples

## Not run: 
# This function is for internal use and is called within the aeddo function.
# It is not intended to be called directly by users.

## End(Not run)

[Package aeddo version 0.1.1 Index]