Skip to content

Commit

Permalink
add sentence to fit_tmb docs
Browse files Browse the repository at this point in the history
  • Loading branch information
James-Thorson-NOAA committed Oct 3, 2023
1 parent 72b8673 commit ed0f5d1
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion R/fit_tmb.R
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@
#' and therefore this option can be used to achieve an arbitrarily low final gradient
#' given sufficient time for well-behaved models. However, this option will also
#' perform strangely or have unexpected consequences for poorly-behaved models, e.g.,
#' when fixed effects are at upper or lower bounds.
#' when fixed effects are at upper or lower bounds. There is no need to increase the value
#' of newtonsteps if the model appears to be converged (i.e., has low final_gradient and none of
#' the standard errors are NA values)
#' @param n sample sizes (if \code{n!=Inf} then \code{n} is used to calculate BIC and AICc)
#' @param getHessian return Hessian for usage in later code
#' @param quiet Boolean whether to print additional messages results to terminal
Expand Down

0 comments on commit ed0f5d1

Please sign in to comment.