update_reference_manual: Update reference manual

In PetterHopp/NVIpackager: Tools to facilitate Development of NVIverse Packages

Update reference manual

Description

Update the PDF reference manual and save it together with the vignettes.

Usage

update_reference_manual(
  pkg = stringi::stri_extract_last_words(usethis::proj_path()),
  pkg_path = usethis::proj_path(),
  manual = "update"
)

Arguments

pkg	[character(1)] The package name. Defaults to stringi::stri_extract_last_words(usethis::proj_path()).
pkg_path	[character(1)] The path to the package directory. Defaults to usethis::proj_path().
manual	[character(1)] Must be one of c("include", "update", "remove"), see details. Defaults to "update".

Details

The default is manual = "update" that will update the reference manual if it exists, but will do nothing if it doesn't exist. Use manual = "include" to make the reference manual for the first time. For both manual = c("include", "update"), the DESCRIPTION and .gitignore will be checked and modified if necessary and the "pkgname.pdf.asis" will be created in addition to the reference manual "pkgname.pdf".

Use manual = "remove" to remove the reference manual. This will remove the reference manual "pkgname.pdf" and the file "pkgname.pdf.asis" and modify .gitignore. Any changes that have been done to the DESCRIPTION will not be reversed as these may also be used by other processes. If these should be reversed, it must be done manually.

Value

None. Creates or updates the PDF reference manual in directory "./vignettes/".

Author(s)

Petter Hopp [e-mail]

Examples

## Not run: 
# Update the reference manual if it already exists
library(NVIpackager)
update_reference_manual(manual = "update")

## End(Not run)

PetterHopp/NVIpackager documentation built on Sept. 14, 2024, 1:24 a.m.