Try to fix warning on nlmixr2est

R/utils.R

@@ -339,36 +339,42 @@ rxModelVarsS3.nlmixr2FitCoreSilent <- function(obj) {
 #' C++ implementation of Matrix's nearPD
 #'
 #' With `ensureSymmetry` it makes sure it is symmetric by applying 0.5*(t(x) + x) before using nmNearPD
-#' 
+#'
 #' @inherit Matrix::nearPD
 #'
+#' @param ensureSymmetry  logical; by default, \code{\link[Matrix]{symmpart}(x)}
+#' is used whenever \code{isSymmetric(x)} is not true.  The user
+#' can explicitly set this to \code{TRUE} or \code{FALSE}, saving the
+#' symmetry test. \emph{Beware} however that setting it \code{FALSE}
+#' for an \bold{a}symmetric input \code{x}, is typically nonsense!
+#'
 #' @examples
-#' 
+#'
 #' set.seed(27)
 #' m <- matrix(round(rnorm(25),2), 5, 5)
 #' m <- m + t(m)
 #' diag(m) <- pmax(0, diag(m)) + 1
 #' (m <- round(cov2cor(m), 2))
-#'     
+#'
 #' near.m <- nmNearPD(m)
 #' round(near.m, 2)
 #' norm(m - near.m) # 1.102 / 1.08
-#'     
+#'
 #' round(nmNearPD(m, only.values=TRUE), 9)
-#'     
+#'
 #' ## A longer example, extended from Jens' original,
 #' ## showing the effects of some of the options:
-#'     
+#'
 #' pr <- matrix(c(1,     0.477, 0.644, 0.478, 0.651, 0.826,
 #'                0.477, 1,     0.516, 0.233, 0.682, 0.75,
 #'                0.644, 0.516, 1,     0.599, 0.581, 0.742,
 #'                0.478, 0.233, 0.599, 1,     0.741, 0.8,
 #'                0.651, 0.682, 0.581, 0.741, 1,     0.798,
 #'                0.826, 0.75,  0.742, 0.8,   0.798, 1),
 #'                nrow = 6, ncol = 6)
-#'     
-#' nc  <- nmNearPD(pr) 
-#' 
+#'
+#' nc  <- nmNearPD(pr)
+#'
 #' @export
 nmNearPD <- function(x, keepDiag = FALSE, do2eigen = TRUE, doDykstra = TRUE, only.values = FALSE, ensureSymmetry=!isSymmetric(x), eig.tol = 1e-6, conv.tol = 1e-7, posd.tol = 1e-8, maxit = 100L, trace = FALSE) {
   if (ensureSymmetry) {