R/stats-list.R

In kota7/outreg: Regression Table for Publication

#' List of Statictics Available on outreg
#' @description Returns all available statistics on \code{\link{outreg}}.
#' Statistics names can be used for customizing the outputs, e.g.,
#' to choose stats to display or to choose stats to put starts.
#' @return a data.frame that matches stat name and display name
#' @export
#' @examples
#' outreg_stat_list()
outreg_stat_list <- function()
{
  data.frame(display_name = unname(unlist(.display_names)),
             stats = names(.display_names), stringsAsFactors = FALSE)
}


#' Return display name for stats
#' @param stats character vector of stats
#' @return character vector of display names
#' @export
get_display_names <- function(stats)
{
  flg <- stats %in% names(.display_names)
  out <- rep(NA_character_, length(stats))
  out[flg] <- .display_names[stats[flg]] %>% unlist() %>% unname()
  out
}