R/variable.list.R

In norment/normentR: NORMENT's Collected Plotting and Functionality Package for R

#' Get variable list
#'
#' This function is a wrapper for both the \code{ls()} and the \code{typeof} function.
#' Output is a data frame with the index, variable name, and the type of all variables 
#' in the global environment (\code{.GlobalEnv}).
#'
#' @usage
#' variable.list()
#' variable.list(pattern = "plotdata")
#' variable.list(class = "double")
#' variable.list(class = c("function","list","dataframe"))
#' variable.list(pattern = "df*", class = c("list","data frame"))
#'
#' @export

variable.list <- function(pattern = glob2rx("*"), class = NULL) {

  type <- unlist(eapply(.GlobalEnv, typeof))
  names <- ls(pattern = pattern, envir = .GlobalEnv, sorted = TRUE)
  
  varlist <- data.frame()
  for (i in seq_along(names)) {
    varlist[i,"index"] <- i
    varlist[i,"varname"] <- names[i]
    varlist[i,"type"] <- type[names[i]]
  }
  
  class[class == "function"] <- "closure"
  class[class == "dataframe"] <- "list"
  class[class == "data frame"] <- "list"

    if (!is.null(class)) {
    varlist <- varlist[varlist$type %in% class, ]
  }
  
  message("Variables sorted alphabetically")
  
  return(varlist)
  
}