R/inspect_valinvec.R

In trustmebro: Inspect and Clean Subject-Generated ID Codes and Related Data

#' Inspect if a value is in a recode map
#'
#' @description
#' Check whether a given value is present as a key in a specified recode map. 
#' Inputs can be validated against a set of predefined categories or labels.
#'
#' @param value A single value to inspect, which is checked against the keys of a recode map.
#' @param recode_map A named vector where the names represent the keys to check against. The values of the vector are ignored.
#'
#' @return A logical value: `TRUE` if the `value` is a key in the `recode_map`, otherwise `FALSE`.
#' @export
#'
#' @examples
#' recode_map <- c(male = "M", female = "F")
#' inspect_valinvec("female", recode_map) # TRUE - "female" is a key in the recode map
#' inspect_valinvec("other", recode_map) # FALSE - "other" is not a key in the recode map
inspect_valinvec <- function(value, recode_map) {
  result <- value %in% names(recode_map)
  
  return(result)
}