R/var_names.R

In favstats/tidytemplate: This is a package that mostly use for personal reasons

#' A Searcher function
#'
#' This function allows you to find variables and their coding.
#' Only works with SPSS data loaded with haven.
#' @param data is a labelled dataframe
#' @param keyword what do you want to search for?
#' @keywords searcher
#' @export
#' @examples
#' var_names(a_labelled_dataset)

#lubripack::lubripack("tidyverse","labelled","haven","sjmisc","magrittr")

### Hilfsfunktion ###

# var_names findet Variablennamen -- benötigt "labelled" und "tidyverse" package!
var_names <- function(data, keyword = "") {
  keyword <- ifelse(keyword %in% "all", "", keyword)
  #if 'all' turn into void, else copy keyword
  lablist <-  data %>%
    labelled::var_label() %>% # extract variable labels
    dplyr::bind_rows() %>% # binding list elements as dataframe
    t() # transpose dataframe
  name_pos <- stringr::str_detect(tolower(lablist[, 1]), tolower(keyword))
  # get position of string
  if(any(name_pos)){ #if the string is found
    dat <-data.frame(var_codes=names(lablist[name_pos, ]),
                     var_names=lablist[name_pos, ],
                     row.names = NULL, stringsAsFactors = F)
    #colnames(dat) <- "var_names"
    cat(paste0("####---- Nice! You found ", nrow(dat) , " variables! ----#### \n \n "))
    return(dat)
  } else{
    cat("Variable Name not found. Try again!")
  }
}