check_calendar_timestep: Check calendar timestep

In seabbs/epinowcast: Flexible Hierarchical Nowcasting

Check calendar timestep

Description

This function verifies if the difference in calendar dates in the provided observations corresponds to the provided timestep of "month".

Usage

check_calendar_timestep(dates, date_var, exact = TRUE)

Arguments

dates	Vector of Date class representing dates.
date_var	The variable in obs representing dates.
exact	Logical, if ⁠TRUE``, checks if all differences exactly match the timestep. If ⁠FALSE“, checks if the sum of the differences modulo the timestep equals zero. Default is TRUE.

Value

This function is used for its side effect of stopping if the check fails. If the check passes, the function returns invisibly.

See Also

Functions used for checking inputs check_design_matrix_sparsity(), check_group(), check_group_date_unique(), check_max_delay(), check_module(), check_modules_compatible(), check_numeric_timestep(), check_observation_indicator(), check_quantiles(), check_timestep(), check_timestep_by_date(), check_timestep_by_group()

seabbs/epinowcast documentation built on Feb. 3, 2025, 9:56 p.m.