Locate or open the pcatR technical user guide

Locates the technical user guide installed with pcatR. The guide defines the package's data schema, validation rules, denominators, descriptive classification logic, privacy cautions, and reporting expectations.

Usage

pcat_user_guide(format = c("pdf", "html"), open = interactive())

Arguments

format

Guide format: PDF or HTML.

open

Logical; open the guide with the operating system's default application.

Value

The normalized guide path, invisibly.

Examples

path <- pcat_user_guide("html", open = FALSE)
path
#> [1] "/home/runner/work/_temp/Library/pcatR/guides/pcatR_Technical_User_Guide.html"

if (interactive()) {
  pcat_user_guide("html", open = TRUE)
}