Skip to content

Commit 801d17b

Browse files
committed
additions to documentation
1 parent b22016f commit 801d17b

File tree

4 files changed

+10
-6
lines changed

4 files changed

+10
-6
lines changed

R/estimation.R

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
#' @param control solver control parameters passed to the nloptr function.
77
#' @param scores whether to calculate the analytic scores (Jacobian) of the
88
#' likelihood. This is not available for the \dQuote{tsissm.autospec} object.
9-
#' @param trace whether to show a progress bar for the automatic selection object.
9+
#' @param trace whether to show a progress bar for the automatic selection object
10+
#' and also output verbose messages.
1011
#' @param debug_mode for development testing, will include the TMB object.
1112
#' @param ... not used.
1213
#' @details The maximum likelihood estimation for this model is described in the

R/tsprofile.R

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@
1616
#' @param nsim the number of paths to generate.
1717
#' @param seed an object specifying if and how the random number generator
1818
#' should be initialized. See the simulate documentation for more details.
19-
#' @param trace whether to show the progress bar. The user is expected to have
20-
#' set up appropriate handlers for this using the \dQuote{progressr} package.
19+
#' @param trace whether to show the progress bar and additionally output verbose messages.
20+
#' The user is expected to have set up appropriate handlers for this using
21+
#' the \code{\link[progressr]{handlers}} function from the \dQuote{progressr} package.
2122
#' @param ... not currently used.
2223
#' @note The function can use parallel functionality as long as the user has set
2324
#' up a \code{\link[future]{plan}} using the future package.

man/estimate.Rd

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tsprofile.Rd

Lines changed: 3 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)