R/replace_na_with.R

In njtierney/naniar: Data Structures, Summaries, and Visualisations for Missing Data

#' Replace NA value with provided value
#'
#' This function helps you replace NA values with a single provided value.
#'   This can be classed as a kind of imputation, and is powered by
#'   [impute_fixed()]. However, we would generally recommend to impute using
#'   other model based approaches. See the `simputation` package, for example
#'   [simputation::impute_lm()]. See [tidyr::replace_na()] for a slightly
#'   different approach, [dplyr::coalesce()] for replacing NAs with values from
#'   other vectors, and [dplyr::na_if()] to replace specified values with NA.
#'
#' @param x vector
#' @param value value to replace
#'
#' @return vector with replaced values
#' @export
#'
#' @examples
#'
#' library(naniar)
#' x <- c(1:5, NA, NA, NA)
#' x
#' replace_na_with(x, 0L)
#' replace_na_with(x, "unknown")
#'
#' library(dplyr)
#' dat <- tibble(
#'   ones = c(NA,1,1),
#'   twos = c(NA,NA, 2),
#'   threes = c(NA, NA, NA)
#' )
#'
#' dat
#'
#' dat %>%
#'   mutate(
#'     ones = replace_na_with(ones, 0),
#'     twos = replace_na_with(twos, -99),
#'     threes = replace_na_with(threes, "unknowns")
#'   )
#'
#' dat %>%
#'   mutate(
#'     across(
#'       everything(),
#'       \(x) replace_na_with(x, -99)
#'     )
#'   )
#'
replace_na_with <- function(x, value) {
  impute_fixed(x, value)
}