check_date_sequence {cleanepi} | R Documentation |
Check whether the order of the sequence of date-events is valid
Description
Checks whether a date sequence in a vector of specified columns is in order or not.
Usage
check_date_sequence(data, target_columns)
Arguments
data |
A data frame |
target_columns |
A vector of event column names. Users should specify at
least 2 column names in the expected order. For example:
target_columns = c("date_symptoms_onset", "date_hospitalization",
"date_death").
When the input data is a |
Value
The input dataset. When found, the incorrect date sequences will be
stored in the report where they can be accessed using
attr(data, "report")
.
Examples
# import the data
data <- readRDS(system.file("extdata", "test_df.RDS", package = "cleanepi"))
# standardize the date values
data <- data |>
standardize_dates(
target_columns = c("date_first_pcr_positive_test", "date.of.admission"),
error_tolerance = 0.4,
format = NULL,
timeframe = NULL
)
good_date_sequence <- check_date_sequence(
data = data,
target_columns = c("date_first_pcr_positive_test", "date.of.admission")
)
[Package cleanepi version 1.0.2 Index]