Merge pull request #807 from nlmixr2/rxUdfUiControl

add rxUdfUiControl()
nlmixr2 · Nov 21, 2024 · 0525f56 · 0525f56
2 parents cfd5621 + de8878d
commit 0525f56
Show file tree

Hide file tree

Showing 17 changed files with 84 additions and 6 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -581,6 +581,7 @@ export(rxTick)
 export(rxToSE)
 export(rxTrans)
 export(rxUdfUi)
+export(rxUdfUiControl)
 export(rxUdfUiData)
 export(rxUdfUiEst)
 export(rxUdfUiIniDf)

diff --git a/NEWS.md b/NEWS.md
@@ -4,6 +4,9 @@
   `babelmixr2` to better check what model is loaded and unload/reload
   as necessary.
 
+- Add `rxUdfUiControl()` to rxode2 user function to get control
+  information from something like `nlmixr2`
+
 # rxode2 3.0.2
 
 - Bug fix for `api`, the censoring function pointer has been updated

diff --git a/R/err-foceiBase.R b/R/err-foceiBase.R
@@ -323,14 +323,14 @@
 #' Handle the single error for normal or t distributions
 #'
 #' @param env Environment for the parsed model
-#' 
+#'
 #' @param pred1 The `data.frame` of the current error
 #'
 #' @param errNum The number of the error specification in the nlmixr2 model
-#' 
+#'
 #' @param rxPredLlik A boolean indicating if the log likelihood should
 #'   be calculated for non-normal distributions.  By default `TRUE`.
-#' 
+#'
 #' @return A list of the lines added.  The lines will contain
 #'
 #' - `rx_yj_` which is an integer that corresponds to the
@@ -347,7 +347,7 @@
 #' - `rx_pred_` The transformed prediction function
 #'
 #' - `rx_r_` The transformed variance
-#' 
+#'
 #' @author Matthew Fidler
 #' @export
 .handleSingleErrTypeNormOrTFoceiBase <- function(env, pred1, errNum=1L, rxPredLlik=TRUE) {
@@ -474,7 +474,7 @@
     .first <- vapply(seq(2, length(.c)), function(i) {
       paste0("(DV==",(i-1),")*(",
              deparse1(.c[[i]]),")")
-      
+
     }, character(1), USE.NAMES=FALSE)
     .last <- vapply(seq(2, length(.c)), function(i) {
       paste0("(", deparse1(.c[[i]]), ")")

diff --git a/R/rudfui.R b/R/rudfui.R
@@ -15,6 +15,7 @@ rxUdfUiReset <- function() {
   .udfUiEnv$lhs <- NULL
   .udfUiEnv$data <- NULL
   .udfUiEnv$est <- NULL
+  .udfUiEnv$control <- NULL
   .udfUiEnv$parsing <- FALSE
   .udfUiEnv$mv <- NULL
   invisible(NULL)
@@ -133,6 +134,35 @@ rxUdfUiData <- function(value) {
          call.=FALSE)
   }
 }
+
+#' Return the control that is being processed or setup control for processing
+#'
+#' @param value when specified, this assigns the control to be
+#'   processed, or resets it by assigning it to be `NULL`.
+#'
+#' @return value of the `data.frame` being processed or `NULL`.
+#'
+#' @export
+#' @family User functions
+#' @author Matthew L. Fidler
+#' @examples
+#'
+#' rxUdfUiControl()
+#'
+rxUdfUiControl <- function(value) {
+  if (missing(value)) {
+    .udfUiEnv$control
+  } else if (is.list(value)) {
+    .udfUiEnv$control <- value
+  } else if (is.null(value)) {
+    .udfUiEnv$control <- value
+  } else {
+    stop("rxUdfUiControl must be called with a list, NULL, or without any arguments",
+         call.=FALSE)
+  }
+  invisible(.udfUiEnv$control)
+
+}
 #' Return the current estimation method for the UI processing
 #'
 #' @param value when specified, this assigns the character value of

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -166,6 +166,7 @@ reference:
   - linMod
   - rxIntToBase
   - rxIntToLetter
+  - rxUdfUiControl
   - rxUdfUiData
   - rxUdfUiEst
   - rxUdfUiIniDf

diff --git a/data/rxReservedKeywords.rda b/data/rxReservedKeywords.rda
diff --git a/data/rxResidualError.rda b/data/rxResidualError.rda
diff --git a/data/rxSyntaxFunctions.rda b/data/rxSyntaxFunctions.rda
diff --git a/man/linMod.Rd b/man/linMod.Rd
diff --git a/man/reexports.Rd b/man/reexports.Rd
diff --git a/man/rxUdfUiControl.Rd b/man/rxUdfUiControl.Rd
diff --git a/man/rxUdfUiData.Rd b/man/rxUdfUiData.Rd
diff --git a/man/rxUdfUiEst.Rd b/man/rxUdfUiEst.Rd
diff --git a/man/rxUdfUiIniLhs.Rd b/man/rxUdfUiIniLhs.Rd
diff --git a/man/rxUdfUiMv.Rd b/man/rxUdfUiMv.Rd
diff --git a/man/rxUdfUiNum.Rd b/man/rxUdfUiNum.Rd
diff --git a/man/rxUdfUiParsing.Rd b/man/rxUdfUiParsing.Rd