R/history.r

In hadley/helpr: Help for R.

#' List all recently called functions.
#' 
#' @return fuctions that are from a package
#' @author Barret Schloerke
#' @keywords internal
get_function_history <- function() {
  rawhist <- NULL
  a <- NULL
  pattern <- "[a-zA-Z_.][a-zA-Z_.0-9]*\\("
  file1 <- tempfile("Rrawhist")
  savehistory(file1)
  rawhist <- readLines(file1)
  unlink(file1)

  # subset then find function names
  rawhist <- grep(pattern, rawhist, value = TRUE )
  funcs <- unlist(str_extract_all(rawhist, pattern))
  funcs <- funcs[ ! funcs %in% c("if(", "for(", "while(", "get_function_history(")]
  funcs <- str_replace_all(funcs, "[(]", "")

  funcs
}


#' List last ten unique functions called from the command line.
#' 
#' @param fun_list function list
#' @author Barret Schloerke
#' @keywords internal
#' @return fuctions that are from a package and their help paths
last_ten_functions <- function(fun_list = get_function_history()) {  
  unique_fun_list <- unique(rev(fun_list))
  if(NROW(unique_fun_list) < 1) return(NULL)
  
  last_ten_funcs <- data.frame(      
      func = unique_fun_list, 
      path = function_help_path(unique_fun_list), 
      stringsAsFactors = FALSE
    )
  last_ten_funcs <- subset( last_ten_funcs, !is.na(path))
  last_ten <- min(10, NROW(last_ten_funcs))

  last_ten_funcs[seq_len(last_ten), ]
}

#' List top 10 most frequently called functions.
#' 
#' @param fun_list function list
#' @return fuctions that are from a package and their help paths
#' @author Barret Schloerke
#' @keywords internal
top_ten_functions <- function(fun_list = get_function_history()) {  
  if(NROW(fun_list) < 1) return(NULL)
  func_count <- table(fun_list)
  
  func_count <- func_count[order(func_count, decreasing = TRUE)]
  
  func_name <- names(func_count)

  top_ten_funcs <- subset(
    data.frame(
      func = func_name, 
      path = function_help_path(func_name), 
      stringsAsFactors = FALSE
    ), 
    !is.na(path)
  )

  top_ten <- min(10, NROW(top_ten_funcs))
  top_ten_funcs[seq_len(top_ten), ]
}


#' Both the top ten most called and last ten functions.
#' 
#' @return list containing the \code{\link{top_ten_functions}} and \code{\link{last_ten_functions}}
#' @author Barret Schloerke
#' @keywords internal
ten_functions <- function() {
  fun_hist <- tryCatch(
    get_function_history(),
    error = function(e) data.frame()
  )

  list(
    last_ten = last_ten_functions(fun_hist),
    top_ten = top_ten_functions(fun_hist)
  )
}