new_item: Create a validation requirement, test case, or test code file

In phuse-org/valtools: Automate Validated Package Creation

Create a validation requirement, test case, or test code file

Description

Create a validation requirement, test case, or test code file

Usage

vt_use_test_case(
  name,
  username = vt_username(),
  title = NULL,
  open = interactive(),
  add_before = NULL,
  add_after = NULL
)

vt_use_test_code(
  name,
  username = vt_username(),
  open = interactive(),
  add_before = NULL,
  add_after = NULL
)

vt_use_req(
  name,
  username = vt_username(),
  title = NULL,
  open = interactive(),
  add_before = NULL,
  add_after = NULL
)

Arguments

name	The name/path of the validation item. These can be named with your file system separator and will be organized as a directory structure. Items are located at ⁠./inst/validation/<ItemType>/{name}⁠.
username	The username to insert into the validation item as the author.
title	Title for the requirement defaults to be the base name passed sans file paths or extensions.
open	Should the newly made file be opened for editing.
add_before, add_after	If either parameters is supplied, the location to add the validation item to the validation configuration. If no parameter is passed the item is added at the end.

Value

Path to the newly created validation item file, invisibly.

Examples

withr::with_tempdir({
vt_create_package("example.package")
setwd("example.package")
vt_add_user_to_config(
  username = whoami::username(),
  name = "Sample Name",
  title = "Sample",
  role = "example"
 )
# Create req at the cases top level `inst/validation/cases/case1`
vt_use_test_case("case1", open = FALSE)

# Create req at `inst/validation/cases/regTests/Update2/case2`
vt_use_test_case("regTests/Update2/case2", open = FALSE, add_before = "case1.md")

# Create a test case using tidy select
vt_use_test_case("case1a", open = FALSE, add_after = tidyselect::starts_with("case1"))

})

phuse-org/valtools documentation built on Nov. 10, 2024, 1:36 a.m.