R/rescale_low_strong_4.R

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

#' Rescale low-strong level Eurobarometer questions
#'
#' Rescale the standard Eurobarometer low-strong variable(s) with
#' categories \code{"Not at all"}, \code{"Low"},
#' \code{"Medium"},  \code{"Strong"}.
#' This is a wrapper function around the \code{\link{rescale_categories}} function.
#' @param column A column from a survey data frame where intensity is
#' measured.
#' @param from Defaults to \code{c("Not at all", "Low",
#' "Medium", "Strong")}.
#' @param to Defaults to \code{c(0,1,2,3)}. If  \code{return_class = "character"} or
#' \code{return_class = "factor"} is selected it returns the abbreviated category
#' names \code{c("none", "low", "medium",
#' "strong")}.
#' @param na_labels  Defaults to \code{c("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"}.
#' @param underscore Defaults to \code{TRUE} in which case factor names or character strings
#' contain underscore_between_words.  This is a better approach for further programming,
#' but you can choose \code{FALSE} for nicer printing results. See examples.
#' @examples
#' rescale_low_strong_4 (column =
#'                         c("DK",
#'                           "Not at all",
#'                           "Low",
#'                           "Medium",
#'                           "Strong"),
#'                       underscore = FALSE,
#'                       return_class = "character")
#'
#'  rescale_low_strong_4 (column =
#'                         c("DK",
#'                           "Not at all",
#'                           "Low",
#'                           "Medium",
#'                           "Strong"),
#'                       return_class = "numeric")
#' @export

rescale_low_strong_4 <- function ( column,
                                 from = c("Not at all", "Low",
                                          "Medium", "Strong"),
                                 to = c(0,1,2,3 ),
                                 na_labels = "DK",
                                 exact_from = TRUE,
                                 return_class = "numeric",
                                 underscore = TRUE) {

  if ( return_class %in% c("character", "factor")) {
    to = c("none", "low", "medium",
           "strong")
  }

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

}