R/rescale_situation.R

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

#' Rescale situtation Eurobarometer trend variables
#'
#' Rescale the standard Eurobarometer situation variable(s) with
#' categories \code{"Very good"}, \code{"Rather good"},
#' \code{"Rather bad"},  \code{"Very bad"}.
#' This is a wrapper function around the \code{\link{rescale_categories}} function.
#' @param column A column from a survey data frame where the situtation is recorded with
#' four categories.
#' @param from Defaults to \code{c("Very good", "Fairly good",
#' "Rather bad", "Very bad")}.
#' @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_good", "rather_good", "rather_bad", "very_bad")}.
#' @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_situation (column =
#'                         c("DK",
#'                           "Very good",
#'                           "Very bad",
#'                           "Rather good",
#'                           "Rather bad"),
#'                       underscore = FALSE,
#'                       return_class = "character")
#'
#'  rescale_situation  (column =
#'                         c("DK",
#'                           "Very good",
#'                           "Very bad",
#'                           "Rather good",
#'                           "Rather bad"),
#'                       return_class = "numeric")
#' @export

rescale_situation <- function ( column,
                                 from = c("Very good",
                                          "Rather good",
                                          "Rather bad",
                                          "Very bad"),
                                 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_good", "rather_good", "rather_bad",
           "very_bad")
  }

  if (underscore == FALSE) {
    to = gsub("_", " ", to)
    }

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

}