make_testing_plan: Build the Testing Plan document and write it to output...

In metrumresearchgroup/mrgvalidate: Create Validation Docs For R Packages

Build the Testing Plan document and write it to output file(s)

Description

This takes the input from automated and/or manual tests and writes them to a .docx file.

Usage

make_testing_plan(
  product_name,
  version,
  language,
  tests,
  auto_info,
  style_dir = NULL,
  out_file = TEST_PLAN_FILE,
  output_dir = getwd(),
  type = "package",
  word_document = TRUE
)

Arguments

product_name	The name of the product you are validating, to be included in the output document.
version	The version number of the product you are validating, to be included in the output document.
language	Denotes the language the package was coded in. Either 'R' or 'Go'. Dictates boiler plate text in the generated validation docs.
tests	Tibble containing all test results, FORMAT: CREATED ON LINE 59 OF generate-docs.R in create_package_docs() or create_metworx_docs().
auto_info	A named list containing the test suite information pulled from the .json files found in auto_test_dir, one element per .json (named with the filename without extension). Same note as tests about exporting and specs.
style_dir	Directory to check for a docx style reference that has the same base name as out_file.
out_file	Filename to write markdown file out to. Any extension will be ignored and replaced with .Rmd
output_dir	Directory to write the output documents to. Defaults to working directory.
type	the type of doc you want to render ("package" or "metworx")
word_document	Logical scaler indicating whether to render a docx document

metrumresearchgroup/mrgvalidate documentation built on March 4, 2023, 7:54 a.m.