R/survey_question_types.R

In DataS-DHSC/consultations: Re-usable functions for describing the responses to a public consultation or call for evidence

#' Group columns into question types
#'
#' Returns a list containing vectors with column names for categorical, multi-choice, and free text questions.
#'
#' @param dummy_response dataframe
#'
#' @return three-element list
#' @export
#'
#' @examples survey_question_types(dummy_response)
survey_question_types <- function(dummy_response){
  # Apply question detection function
  question_types <- as.data.frame(apply(dummy_response, 2, survey_detect_qtypes), stringsAsFactors = FALSE)
  question_types$question <- rownames(question_types)
  colnames(question_types) <- c("type", "question")

  # Return list with three vectors:
  # each vector containing the columns that have that type of question
  return(list(categorical = question_types[question_types$type == "categorical", "question"],
              multichoice = question_types[question_types$type == "multi-choice", "question"],
              freetext = question_types[question_types$type == "free text", "question"]))
}