Merge pull request #478 from humanpred/477-resetting-summary-causes-error-for-pkncasetsummaryreset-true

billdenney · web-flow · commit bb70375d5c51 · 2025-11-06T09:28:42.000-07:00
Warn on use of `PKNCA.set.summary(reset=TRUE)`
diff --git a/NEWS.md b/NEWS.md
@@ -15,6 +15,8 @@ the dosing including dose amount and route.
 
 * `pk.calc.half.life()` now returns also `lambda.z.corrxy`, the correlation between
   the time and the log-concentration of the lambda z points.
+* `PKNCA.set.summary(reset = TRUE)` warns that it may break the use of
+  `summary()` (#477)
 
 # PKNCA 0.12.1
 
diff --git a/R/PKNCA.options.R b/R/PKNCA.options.R
@@ -494,7 +494,8 @@ PKNCA.options.describe <- function(name) {
 #'   digits to round.  If a function, it is expected to return a scalar number
 #'   or character string with the correct results for an input of either a
 #'   scalar or a two-long vector.
-#' @param reset Reset all the summary instructions
+#' @param reset Reset all the summary instructions to no instruction (this is
+#'   not intended for general use)
 #' @returns All current summary settings (invisibly)
 #' @seealso [summary.PKNCAresults()]
 #' @family PKNCA calculation and summary settings
@@ -512,6 +513,7 @@ PKNCA.options.describe <- function(name) {
 PKNCA.set.summary <- function(name, description, point, spread,
                               rounding=list(signif=3), reset=FALSE) {
   if (reset) {
+    warning("`reset = TRUE` is not intended for general use, summary() may not work after resetting summary instructions")
     current <- list()
   } else {
     current <- get("summary", envir=.PKNCAEnv)
diff --git a/man/PKNCA.set.summary.Rd b/man/PKNCA.set.summary.Rd
