Skip to contents

Replace NA with a value when a flag column indicates the skip is valid

Source: R/impute_from_flag.R
impute_from_flag.Rd

For each variable in vars, looks for a corresponding flag column named {var}{flag_suffix}. Where the original variable is NA and the flag equals 1, the value is replaced with impute_value (default 0).

Usage

impute_from_flag(
  data,
  vars,
  flag_suffix = "_NA_X",
  impute_value = 0,
  flag_map = NULL
)

Arguments

data

A data frame.

vars

A character vector of column names to impute.

flag_suffix

String appended to each variable name to find the flag column. Defaults to "_NA_X".

impute_value

Value to impute when the flag is 1 and the variable is NA. Defaults to 0.

flag_map

Optional named character vector mapping variable names to flag column names. When provided, overrides paste0(var, flag_suffix) for matched names. For example, c("Staff_RegVlntr_2023" = "Staff_RegVlntr_NA").

Value

data with imputed values.

Examples

d <- data.frame(x = c(1, NA, 3), x_NA_X = c(0, 1, 0))
impute_from_flag(d, "x")
#>   x x_NA_X
#> 1 1      0
#> 2 0      1
#> 3 3      0

# Using flag_map for non-standard flag column names
d2 <- data.frame(val_2023 = c(NA, 5), val_flag = c(1, 0))
impute_from_flag(d2, "val_2023", flag_map = c(val_2023 = "val_flag"))
#>   val_2023 val_flag
#> 1        0        1
#> 2        5        0