make_requirements: Build the Requirements Specification and write it to output...

In metrumresearchgroup/mrgvalidate: Create Validation Docs For R Packages

Build the Requirements Specification and write it to output file(s)

Description

Build the Requirements Specification and write it to output file(s)

Usage

make_requirements(
  product_name,
  version,
  df,
  roles = NULL,
  style_dir = NULL,
  out_file = REQ_FILE,
  output_dir = getwd(),
  type = "package",
  word_document = TRUE
)

Arguments

product_name	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.
df	Tibble containing stories, requirements, and tests. Created in create_test_framework().
roles	A data frame of user roles. If specified, this will be inserted as a table under a "User Roles" section.
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 .md
output_dir	Directory to write the output documents to. Defaults to working directory.
word_document	Logical scaler indicating whether to render a docx document

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