dtm_level: Create a 'dtm_level' object

View source: R/derive_vars_dt_dtm_utils.R

dtm_levelR Documentation

Create a dtm_level object

Description

Create a dtm_level object

Usage

dtm_level(level)

Arguments

level

Datetime level

Permitted values

"Y" (year, highest level), "M" (month), "D" (day), "h" (hour), "m" (minute), "s" (second, lowest level), "n" (none)

Default value

none

Details

A dtm_level object is an ordered factor, i.e., two objects can be compared.

Value

A dtm_level object

See Also

Utilities used for date imputation: dt_level(), get_imputation_target_date(), get_imputation_target_time(), get_partialdatetime(), restrict_imputed_dtc_dt(), restrict_imputed_dtc_dtm()

Examples

# Create a dtm_level object with level "D" (day)
level_day <- admiral:::dtm_level("D")
print(level_day)

# Create a dtm_level object with level "h" (hour)
level_hour <- admiral:::dtm_level("h")
print(level_hour)

# Compare two dtm_level objects
level_day > level_hour # TRUE, because "D" is larger than "h".

admiral documentation built on June 26, 2025, 1:08 a.m.