Create validation docs

This function is the entry point for creating validation docs with the new 7-document format for packages.

create_package_docs(
  product_name,
  version,
  language = c("R", "Go"),
  repo_url,
  specs,
  release_notes_file,
  auto_test_dir = NULL,
  style_dir = NULL,
  output_dir = getwd(),
  write = TRUE,
  cleanup_rmd = TRUE
)

Arguments

product_name

The product being validated.

version

The version number of the product.

language

Denotes the language the package was coded in. Either 'R' or 'Go'. Dictates boiler plate text in the generated validation docs.

repo_url

Character string denoting the url of repository.

specs

tibble of stories and requirements. See input_formats.

release_notes_file

file path to a formatted markdown doc of release notes. This should contain two top-level headers for "Changes and New Features" and "Bug Fixes". For packages, this can typically be extracted from the relevant entry in the NEWS.md file.

auto_test_dir

Path to directory containing .csv and .json files with results from automated tests. See input_formats.

style_dir

Directory that has style references for the generated docx files. When generating each output file, Pandoc will be instructed to use the reference file from this directory that has the same base name (if it exists).

output_dir

Directory to write the output documents to. Defaults to working directory.

write

Whether to create the output docs. Setting this to FALSE is useful when you're just interested in the return value.

cleanup_rmd

Whether to delete the copied RMD's after the word documents are generated. Defaults to TRUE.

Value

In addition to creating the validation docs, a tibble that joins the tests with specs is returned invisibly.