From 101d16ad5428b82bc47973a0dda9c55f5fbf20c9 Mon Sep 17 00:00:00 2001 From: Bill Denney Date: Tue, 20 Aug 2024 13:49:50 -0400 Subject: [PATCH] Documentation fix --- R/profile.R | 4 +++- man/profileNlmixr2FitCoreRet.Rd | 5 ++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/R/profile.R b/R/profile.R index 3cec54f..980b9ee 100644 --- a/R/profile.R +++ b/R/profile.R @@ -84,11 +84,13 @@ profile.nlmixr2FitCore <- function(fitted, ..., #' Give the output data.frame for a single model for profile.nlmixr2FitCore #' #' @inheritParams profile.nlmixr2FitCore +#' @param fixedVal The value that `which` is fixed to in case the model does not +#' converge. #' @return A data.frame with columns named "Parameter" (the parameter name(s) #' that were fixed), OFV (the objective function value), and the current #' estimate for each of the parameters. #' @family Profiling -profileNlmixr2FitCoreRet <- function(fitted, which, fixedVal, rowname = 0) { +profileNlmixr2FitCoreRet <- function(fitted, which, fixedVal) { if (inherits(fitted, "try-error")) { ret <- data.frame(Parameter = which, OFV = NA_real_, X = fixedVal) names(ret)[3] <- which diff --git a/man/profileNlmixr2FitCoreRet.Rd b/man/profileNlmixr2FitCoreRet.Rd index 157be3c..ef1ff32 100644 --- a/man/profileNlmixr2FitCoreRet.Rd +++ b/man/profileNlmixr2FitCoreRet.Rd @@ -4,13 +4,16 @@ \alias{profileNlmixr2FitCoreRet} \title{Give the output data.frame for a single model for profile.nlmixr2FitCore} \usage{ -profileNlmixr2FitCoreRet(fitted, which, fixedVal, rowname = 0) +profileNlmixr2FitCoreRet(fitted, which, fixedVal) } \arguments{ \item{fitted}{The fit model} \item{which}{The parameter names to perform likelihood profiling on (\code{NULL} indicates all parameters)} + +\item{fixedVal}{The value that \code{which} is fixed to in case the model does not +converge.} } \value{ A data.frame with columns named "Parameter" (the parameter name(s)