R/example.R

In ThinkR-open/testdown: 'testhat' Results to Bookdown

#' Run a test_down example
#'
#' @inheritParams test_down
#'
#' @return Path to the report
#' @export
#'
#' @examples
#' if (interactive()){
#'  dir_book <- tempfile()
#'  dir.create(dir_book)
#'  test_down_example(book_path = dir_book)
#' }
test_down_example <- function(
  project_name = NULL,
  author = NULL,
  environment = here::here(),
  pkg = system.file("fakepkg", package = "testdown"),
  book_path = "tests/testdown",
  with_help = TRUE,
  open = interactive()
){
  test_down(
    project_name = project_name,
    author = author,
    environment = environment,
    pkg = pkg,
    book_path = book_path,
    with_help = with_help,
    open = open
  )
}