R/rescale_satisfaction.R

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

#' Rescale satisfaction level Eurobarometer questions
#'
#' Rescale the standard Eurobarometer satisfaction variable(s) with
#' categories \code{"Very satisfied"}, \code{"Fairly satisfied"},
#' \code{"Not very satisfied"},  \code{"Not at all satisfied"}.
#' This is a wrapper function around the \code{\link{rescale_categories}} function.
#' @param column A column from a survey data frame where gender is recorded.
#' @param from Defaults to \code{c("Very satisfied", "Fairly satisfied",
#' "Not very satisfied", "Not at all satisfied")}.
#' @param to Defaults to \code{c(2,1,-1,-2)}. If  \code{return_class = "character"} or
#' \code{return_class = "factor"} is selected it returns the abbreviated category
#' names \code{c("very_satisfied", "fairly_satisfied", "not_very_satisfied",
#' "not_at_all_satisfied")}.
#' @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_satisfaction (column =
#'                         c("DK",
#'                           "Very satisfied",
#'                           "Fairly satisfied",
#'                           "Not very satisfied",
#'                           "Not at all satisfied"),
#'                       underscore = FALSE,
#'                       return_class = "character")
#'
#'  rescale_satisfaction (column =
#'                         c("DK",
#'                           "Very satisfied",
#'                           "Fairly satisfied",
#'                           "Not very satisfied",
#'                           "Not at all satisfied"),
#'                       return_class = "numeric")
#' @export

rescale_satisfaction <- function ( column,
                                 from = c("Very satisfied",
                                          "Fairly satisfied",
                                          "Not very satisfied",
                                          "Not at all satisfied"),
                                 to = c(2,1,-1,-2),
                                 na_labels = "DK",
                                 exact_from = TRUE,
                                 return_class = "numeric",
                                 underscore = TRUE) {

  if ( return_class %in% c("character", "factor")) {
    to = c("very_satisfied", "fairly_satisfied", "not_very_satisfied",
           "not_at_all_satisfied")
  }

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

}