makeUnitVignette: Make Vignette for Unit Tests

Description Usage Arguments Value

Description

Builds a vignette for unit tests in a package using the utest and a template vignette file.

Usage

1
2
3
  makeUnitVignette(pkg,
    file = paste(pkg, "-unitTests.pdf", sep = ""), ...,
    check = FALSE)

Arguments

pkg

Package name

file

Output file (.Rnw, .tex, or .pdf)

...

extra arguments passed to utest.

check

logical that indactes the cal was made from R CMD check, in which case the vignette is updated only if results of unit tests can be found in the unit test output directory, where they would have been generated by utest.

Value

Result of running unit test suite



Search within the pkgmaker package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.