check_timestep_by_date: Check timestep by date

In seabbs/epinowcast: Flexible Hierarchical Nowcasting

Check timestep by date

Description

This function verifies if the difference in dates within each date in the provided observations corresponds to the provided timestep. This check is performed for both report_date and reference_date and for each group in obs.

Usage

check_timestep_by_date(obs, timestep = "day", exact = TRUE)

Arguments

obs	Any of the types supported by data.table::as.data.table().
timestep	The timestep to used. This can be a string ("day", "week", "month") or a numeric whole number representing the number of days.
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 checking the timestep by date in obs. If the check passes for all dates, the function returns invisibly. Otherwise, it stops and returns an error message.

See Also

Functions used for checking inputs check_calendar_timestep(), 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_group()

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