Skip to contents

Restrict Imputed --DTC date to Minimum/Maximum Dates

Source: R/derive_vars_dtm.R
restrict_imputed_dtc_dtm.Rd

Restrict Imputed --DTC date to Minimum/Maximum Dates

Usage 

restrict_imputed_dtc_dtm(
  dtc,
  imputed_dtc,
  min_dates,
  min_dates_strict,
  max_dates,
  max_dates_strict
)

Arguments

dtc

The --DTC date to impute

A character date is expected in a format like yyyy-mm-dd or yyyy-mm-ddThh:mm:ss. Trailing components can be omitted and - is a valid "missing" value for any component.

Permitted values

a character date variable

Default value

none

imputed_dtc

The imputed --DTC date

Default value

none

min_dates

Minimum dates

A list of dates is expected. It is ensured that the imputed date is not before any of the specified dates, e.g., that the imputed adverse event start date is not before the first treatment date. Only dates which are in the range of possible dates of the dtc value are considered. The possible dates are defined by the missing parts of the dtc date (see example below). This ensures that the non-missing parts of the dtc date are not changed. A date or date-time object is expected. For example

library(lubridate)
impute_dtc_dtm(
  "2020-11",
  min_dates = list(
   ymd_hm("2020-12-06T12:12"),
   ymd_hm("2020-11-11T11:11")
  ),
  highest_imputation = "M"
)
#> [1] "2020-11-11T11:11:00"

returns "2020-11-11T11:11:00" because the possible dates for "2020-11" range from "2020-11-01T00:00:00" to "2020-11-30T23:59:59". Therefore "2020-12-06T12:12:12" is ignored. Returning "2020-12-06T12:12:12" would have changed the month although it is not missing (in the dtc date).

For date variables (not datetime) in the list the time is imputed to "00:00:00". Specifying date variables makes sense only if the date is imputed. If only time is imputed, date variables do not affect the result.

Permitted values

a list of dates, e.g. list(ymd_hms("2021-07-01T04:03:01"), ymd_hms("2022-05-12T13:57:23"))

Default value

NULL

min_dates_strict

Minimum dates (strict)

The argument works like the min_dates argument but it affects the behavior of the min_dates and max_dates arguments. The range that is used to determine which of the min_dates and max_dates are considered is restricted by the dates specified for min_dates_strict (see example below and the example in the "Avoid Imputed Dates Before a Particular Date" section in vignette("imputation")).

This argument is useful if the max_dates argument is used and there are strict restrictions on the imputed date, like the event start date when the event end date is imputed.

For example

library(lubridate)
impute_dtc_dtm(
  c("2020-11", "2020-11"),
  min_dates_strict = list(
   c(ymd_hm("2020-11-24T00:00"), ymd_hm("2020-11-11T11:11"))
  ),
  max_dates = list(
    c(ymd_hm("2020-11-22T12:12"), ymd_hm("2020-11-22T12:12"))
  ),
  highest_imputation = "M",
  date_imputation = "last",
  time_imputation = "last"
)
#> [1] "2020-11-30T23:59:59" "2020-11-22T12:12:00"

returns ("2020-11-30T23:59:59", "2020-11-22T12:12:00"). The possible dates for "2020-11" range from "2020-11-01T00:00:00" to "2020-11-30T23:59:59".

For the first element, the min_dates_strict argument restricts this range to "2020-11-24T00:00:00" to "2020-11-30T23:59:59". Therefore "2020-11-22T12:12:00" (from the max_dates argument) is ignored as it is not within the restricted range.

For the second element, the min_dates_strict argument restricts this range to "2020-11-11T11:11:00" to "2020-11-30T23:59:59". In this case "2020-11-22T12:12:00" (from the max_dates argument) is within the restricted range and is considered.

Permitted values

a list of dates, e.g. list(ymd_hms("2021-07-01T04:03:01"), ymd_hms("2022-05-12T13:57:23"))

Default value

NULL

max_dates

Maximum dates

A list of dates is expected. It is ensured that the imputed date is not after any of the specified dates, e.g., that the imputed date is not after the data cut off date. Only dates which are in the range of possible dates are considered. A date or date-time object is expected.

For date variables (not datetime) in the list the time is imputed to "23:59:59". Specifying date variables makes sense only if the date is imputed. If only time is imputed, date variables do not affect the result.

Permitted values

a list of dates, e.g. list(ymd_hms("2021-07-01T04:03:01"), ymd_hms("2022-05-12T13:57:23"))

Default value

NULL

max_dates_strict

Maximum dates (strict)

The argument works like the max_dates argument but it affects the behavior of the min_dates and max_dates arguments. The range that is used to determine which of the min_dates and max_dates are considered is restricted by the dates specified for max_dates_strict (see example below).

This argument is useful if the min_dates argument is used and there are strict restrictions on the imputed date, like date of death or the event end date when the event start date is imputed.

For example

library(lubridate)
impute_dtc_dtm(
  c("2020-11", "2020-11"),
  max_dates_strict = list(
   c(ymd_hm("2020-11-24T00:00"), ymd_hm("2020-11-11T11:11"))
  ),
  min_dates = list(
    c(ymd_hm("2020-11-22T12:12"), ymd_hm("2020-11-22T12:12"))
  ),
  highest_imputation = "M",
  date_imputation = "first",
  time_imputation = "first"
)
#> [1] "2020-11-22T12:12:00" "2020-11-01T00:00:00"

returns ("2020-11-22T12:12:00", "2020-11-01T00:00:00"). The possible dates for "2020-11" range from "2020-11-01T00:00:00" to "2020-11-30T23:59:59".

For the first element, the max_dates_strict argument restricts this range to "2020-11-01T00:00:00" to "2020-11-24T00:00:00". The date "2020-11-22T12:12:00" (from the min_dates argument) is within the restricted range and is therefore considered.

For the second element, the max_dates_strict argument restricts this range to "2020-11-01T00:00:00" to "2020-11-11T11:11:00". In this case "2020-11-22T12:12:00" (from the max_dates argument) is outside the restricted range and thus it is ignored.

Permitted values

a list of dates, e.g. list(ymd_hms("2021-07-01T04:03:01"), ymd_hms("2022-05-12T13:57:23"))

Default value

NULL

Value

  • The last of the minimum dates (min_dates and min_dates_strict) which are in the range of the partial --DTC date (dtc)

  • The first of the maximum dates (max_dates and max_dates_strict) which are in the range of the partial --DTC date (dtc)

  • imputed_dtc if the partial --DTC date (dtc) is not in range of any of the minimum or maximum dates.

Details

The function will throw an error if imputation rules cause an invalid datetime (e.g. "2020-02-01T25:00:00") to be generated. In this case, the user should adjust the imputation rules.

See also

impute_dtc_dtm(), impute_dtc_dt()

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