create_metworx_docs: Create validation docs for Metworx platform

In metrumresearchgroup/mrgvalidate: Create Validation Docs For R Packages

Create validation docs for Metworx platform

Description

As of mrgvalidate 2.0.0, this function is a prototype for creating Metworx platform docs with the new 7-document format. However, it has been labeled "experimental" because it has not yet been fully vetted in a real Metworx validation.

Usage

create_metworx_docs(
  product_name,
  version,
  specs,
  release_notes_file = NULL,
  auto_test_dir = NULL,
  man_test_dir = NULL,
  roles = 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.
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".
auto_test_dir	Path to directory containing .csv and .json files with results from automated tests. See input_formats.
man_test_dir	Path to directory containing .md files and screenshots for results from manual tests. See input_formats.
roles	A data frame of user roles that, if specified, is inserted into the requirements document.
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.

See Also

create_package_docs()

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