ncar (version 0.7.2)

pdfIQ: Installation Qualification (IQ) report to a pdf file

Description

Generate a self-contained PDF report that documents whether the ncar / NonCompart packages are correctly installed, intact, loadable, and operational in the user's own R environment. It is intended as Installation Qualification (IQ) evidence, in the spirit of the WinNonlin validation suite. The report uses only base R and the package's own pdf helpers, so it requires no LaTeX, pandoc, or other external tools.

Usage

pdfIQ(fileName = "ncar-IQ-Report.pdf", pkgs = c("ncar", "NonCompart"),
      functional = TRUE, performedBy = "", paper = "auto", sigField = FALSE)

Value

Invisibly returns a list with elements fileName, qualified

(logical), checks (a data frame of every check with its Section, Item, Result and Status), and the counts nPass, nFail, nWarn. A PDF file is written to fileName as a side effect.

Arguments

fileName

file name to save the PDF report

pkgs

character vector of package names to qualify. Their declared dependencies are checked automatically.

functional

if TRUE, run a small operational check: a known NCA computation (Theophylline subject 1) is compared with an external WinNonlin reference within a relative tolerance of 1e-3, plus two control tests that verify the comparator itself (a known-match must pass, a known-differ must fail).

performedBy

name of the person performing the qualification, printed in the report header. Defaults to the login name.

paper

paper size: "letter", "a4", or "auto" (the default), which selects "letter" in a United States locale and "a4" elsewhere. The report uses 1 inch margins on every side and places the signature (approval) page first.

sigField

if TRUE, add Adobe Acrobat Reader signature fields to the finished report (via addSigField) so it can be signed with one click in Acrobat Reader.

Author

Kyun-Seop Bae <[email protected]>

Details

The report contains: (1) the test environment (R version, platform, OS, locale, library paths); (2) installed package versions, locations and declared-dependency version satisfaction; (3) file integrity via checkMD5sums (PASS when files match the MD5 manifest, FAIL on mismatch, WARN when no manifest is present, e.g. for a local source install rather than a CRAN install); (4) namespace load and presence of core exported functions; (5) the optional functional verification; an overall QUALIFIED / NOT QUALIFIED verdict; a signature block; and a sessionInfo appendix.

See Also

pdfNCA, txtNCA, checkMD5sums, sessionInfo

Examples

#pdfIQ()
#pdfIQ(fileName = "MyInstall-IQ.pdf", performedBy = "Jane Doe")
#res <- pdfIQ()
#res$qualified
#res$checks