R/debug_testall.R

In andrebleier/testall: A test package to sanity check argument dependencies within selfwritten functions

#' debugonce_testall
#' This function consumes an object of class \code{testall_summary} with the
#' ultimate goal to debug your function with a suggested specifications
#' @param sug an object of class \code{testall_summary}
#' @param scenario an optional numeric value indicating which scenario from sug$tests
#' will be used for debugging.
#'
#' @return Will take you directly into debug mode and will not return anything
#' @export
#'
#' @examples
#' # NOT RUN:
#' suggestion <- test_all(mean, list(x = c('asd')))
#' debugonce_testall(suggestion)
debugonce_testall <- function(sug, scenario = 1) {
  # check input type
  if (!inherits(sug, 'testall_summary')) {
    stop(paste0(sQuote('sug'), " has to be of class testall_summary"))
  }

  # check if there are any errors
  if (length(sug$tests) == 0) {
    return(cat('found no errors - nothing to debug'))
  }

  # function name
  fun <- sug$fun

  # used args
  debug_args <- sug$tests[[scenario]]

  # remove error message in args
  debug_args["test_all_errors"] <- NULL

  debugonce(fun = fun,
            text = paste0('Scenario: ',
                          paste0(paste(names(debug_args),
                                       debug_args,
                                       sep = " = "),
                                 collapse = ", "))
            )
  do.call(fun, args = debug_args)
  return(invisible())
}