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

View source: R/IQNCA.R

IQNCAR Documentation

Installation Qualification (IQ) report to a pdf file

Description

Generate a self-contained PDF report documenting whether the NonCompart package is correctly installed, intact, loadable, and operational in the user's own R environment. It is intended as Installation Qualification (IQ) evidence. The report uses only base R and the package's own pdf helpers, so it requires no LaTeX, pandoc, or other external tools. The signature (approval) page is placed first and the report uses 1 inch margins on every side, with Letter paper in a United States locale and A4 elsewhere.

Usage

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

Arguments

fileName

file name to save the PDF report.

pkgs

character vector of package names to qualify; defaults to "NonCompart". Declared dependencies are checked automatically.

functional

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

performedBy

name of the person performing the qualification, printed on the signature page. Defaults to the login name.

paper

paper size: "letter", "a4", or "auto" (the default; Letter in a United States locale, A4 elsewhere).

sigField

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

Details

The report contains: the test environment (R version, platform, OS, locale, library paths); the installed package version, location and declared-dependency satisfaction; file integrity via checkMD5sums (PASS / FAIL / WARN when no manifest is present - see writeMD5NCA); namespace load and core exports; an optional functional verification; an overall QUALIFIED / NOT QUALIFIED verdict; a sessionInfo appendix; and a per-file md5 checksum appendix.

Value

Invisibly, a list with fileName, qualified, paper, checks (a data frame of every check), and the counts nPass, nFail, nWarn. A PDF file is written to fileName.

Author(s)

Kyun-Seop Bae <k@acr.kr>

See Also

OQNCA, writeMD5NCA, sNCA, tblNCA

Examples

#IQNCA()
#res <- IQNCA(performedBy = "Jane Doe"); res$qualified

NonCompart documentation built on Nov. 15, 2026, 5:07 p.m.