R/rescale_optimism_4.R

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

#' Rescale 4-level optimism questions
#'
#' Rescale Eurobarometer trust in institutions variable with two levels,
#' \code{"Very optimistic"} and \code{"Fairly optimistic"} and
#' \code{"Fairly pessimistic"}, \code{"Very pessimistic"}.
#' This is a wrapper function around the \code{\link{rescale_categories}} function.
#' @param column A column from a survey data frame where trust in an institution
#' is recorded.
#' @param from Defaults \code{"Very optimistic"},  \code{"Fairly optimistic"} and
#' \code{"Fairly pessimistic"}, \code{"Very pessimistic"}.
#' @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_optimistic", "fairly_optimistic",
#' "fairly_pessimistic", "very_pessimistic")}.
#' @param na_labels  Defaults to \code{"default"}.
#' @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_optimism_4  (column =
#' c("Very optimistic",
#'   "Fairly optimistic",
#'   "Fairly pessimistic",
#'   "Very pessimistic",
#'   "DK", "NT/NV"),
#' na_labels = "default",
#' return_class = "character")
#'
#' rescale_optimism_4  (column =
#'                      c("Very optimistic",
#'                      "Fairly optimistic",
#'                      "Fairly pessimistic",
#'                      "Very pessimistic",
#'                      "DK", "NT/NV"),
#'                      na_labels = "default",
#'                      return_class = "numeric")
#' @export

rescale_optimism_4 <- function ( column,
                                 from = c("Very optimistic",
                                          "Fairly optimistic",
                                          "Fairly pessimistic",
                                          "Very pessimistic"),
                                 to = c(2,1,-1, -2),
                                 na_labels = "default",
                                 underscore = TRUE,
                                 exact_from = TRUE,
                                 return_class = "numeric") {
  if ( return_class %in% c("character", "factor")) {
    to <- c("very_optimistic", "fairly_optimistic",
            "fairly_pessimistic", "very_pessimistic" )
    if (underscore == FALSE) {
      to <- gsub("_", " ", to)
    }
  }

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

}