test_down | R Documentation |
This function turns the results of testthat into a bookdown. Each chapter is a context. The first page gives a summary of all the tests.
test_down(
project_name = NULL,
author = NULL,
pkg = here::here(),
environment = here::here(),
book_path = "tests/testdown",
with_help = TRUE,
open = interactive()
)
project_name |
The name you want to give to the project. The default is 'NULL', which will be then be converted to 'basename(here::here())'. |
author |
The author of the test report. Default is set to 'NULL', then it will be skipped. |
pkg |
The path to the package to document. Default is 'here::here()'. |
environment |
A name for the testing environment. Default is 'here::here()'. |
book_path |
The path to the bookdown output. Default is '"tests/testdown"'. |
with_help |
Should the help appendix be added? Default is 'TRUE'. |
open |
Should the bookdown be opened once compiled? Default is 'interactive()'. |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.