From 539734f6cf4ff3d49ff329c72a2dacb651dbf068 Mon Sep 17 00:00:00 2001 From: Sean Anderson Date: Tue, 26 Mar 2024 10:16:22 -0700 Subject: [PATCH] Fix arg in docs --- R/tmb-sim.R | 2 +- man/simulate.sdmTMB.Rd | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/R/tmb-sim.R b/R/tmb-sim.R index 9fadde229..890677a5d 100644 --- a/R/tmb-sim.R +++ b/R/tmb-sim.R @@ -296,7 +296,7 @@ sdmTMB_simulate <- function(formula, #' @param object sdmTMB model #' @param nsim Number of response lists to simulate. Defaults to 1. #' @param seed Random number seed -#' @param params How parameters should be treated. `"mle-eb"`: fixed effects +#' @param type How parameters should be treated. `"mle-eb"`: fixed effects #' are at their maximum likelihood (MLE) estimates and random effects are at #' their empirical Bayes (EB) estimates. `"mle-mvn"`: fixed effects are at #' their MLEs but random effects are taken from a single approximate sample. diff --git a/man/simulate.sdmTMB.Rd b/man/simulate.sdmTMB.Rd index fe2188a19..58803398e 100644 --- a/man/simulate.sdmTMB.Rd +++ b/man/simulate.sdmTMB.Rd @@ -22,6 +22,13 @@ \item{seed}{Random number seed} +\item{type}{How parameters should be treated. \code{"mle-eb"}: fixed effects +are at their maximum likelihood (MLE) estimates and random effects are at +their empirical Bayes (EB) estimates. \code{"mle-mvn"}: fixed effects are at +their MLEs but random effects are taken from a single approximate sample. +This latter option is a suggested approach if these simulations will be +used for goodness of fit testing (e.g., with the DHARMa package).} + \item{model}{If a delta/hurdle model, which model to simulate from? \code{NA} = combined, \code{1} = first model, \code{2} = second mdoel.} @@ -35,13 +42,6 @@ in the \href{https://github.com/pbs-assess/sdmTMBextra}{sdmTMBextra} package.} \item{...}{Extra arguments (not used)} - -\item{params}{How parameters should be treated. \code{"mle-eb"}: fixed effects -are at their maximum likelihood (MLE) estimates and random effects are at -their empirical Bayes (EB) estimates. \code{"mle-mvn"}: fixed effects are at -their MLEs but random effects are taken from a single approximate sample. -This latter option is a suggested approach if these simulations will be -used for goodness of fit testing (e.g., with the DHARMa package).} } \value{ Returns a matrix; number of columns is \code{nsim}.