R/rescale_time_frequency_3.R

In antaldaniel/surveyreader: Data cleaning and integration for survey files

#' Rescale time frequency 3
#'
#' Create a uniform variable from three frequency categories such as
#' \code{"Frequently"}, \code{"Occasionally"} and \code{"Never"}.
#' This is a wrapper function around the the \code{\link{rescale_categories}} function.
#' @param column A column from a survey data frame where
#' time frequency is recorded with only three levels.
#' @param from Defaults to \code{c("frequently", "occasionally", "never")}.
#' @param to Defaults to \code{c(1,0.5,0)} )
#' @param na_labels  Defaults to \code{c("NA","DK")}
#' @param exact_from Deafults to \code{TRUE}. If \code{FALSE} you can use the
#' partial matching, but beware that in this case, \code{"twenty"} will be replaced by
#' @param return_class Default is \code{"numeric"}, alternatives \code{"character"} or
#' \code{"factor"}.
#' @examples
#' rescale_time_frequency_3 (column = c(
#'  "frequently", "occasionally", "never", "NEVER", "NA", "DK"))
#' @export

rescale_time_frequency_3 <- function ( column,
                          from = c("Frequently",
                                   "Occasionally",
                                   "Never"),
                          to = c(1,0.5,0),
                          na_labels = c("NA","DK"),
                          exact_from = TRUE,
                          return_class = "numeric" ) {

  return(rescale_categories(column = column,
                            from = from, to = to,
                            na_labels = na_labels,
                            exact_from = exact_from,
                            return_class = return_class))

 }