Skip to contents

Get internal timestep

Source: R/utils.R
get_internal_timestep.Rd

This function converts the string representation of the timestep to its corresponding numeric value or returns the numeric input (if it is a whole number). For "day", "week", it returns 1 and 7 respectively. "month" is not supported and will throw an error. If the input is a numeric whole number, it is returned as is.

Usage

get_internal_timestep(timestep)

Arguments

timestep

The timestep to used. This can be a string ("day", "week") or a numeric whole number representing the number of days. Note that "month" is not currently supported in user-facing functions and will throw an error if used.

Value

A numeric value representing the number of days for "day" and "week", or the input value if it is a numeric whole number.

See also

Utility functions aggregate_rolling_sum(), coerce_date(), coerce_dt(), date_to_numeric_modulus(), is.Date(), stan_fns_as_string()