Skip to content

Commit

Permalink
test code needs glmmTMB
Browse files Browse the repository at this point in the history
Fixes #806
  • Loading branch information
strengejacke committed Sep 18, 2023
1 parent 6ac92f7 commit 2e95247
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 31 deletions.
46 changes: 23 additions & 23 deletions R/find_algorithm.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,35 @@
#' @inheritParams find_parameters
#'
#' @return A list with elements depending on the model.
#' \cr
#'
#' For frequentist models:
#' \itemize{
#' \item `algorithm`, for instance `"OLS"` or `"ML"`
#' \item `optimizer`, name of optimizing function, only applies to
#' - `algorithm`, for instance `"OLS"` or `"ML"`
#' - `optimizer`, name of optimizing function, only applies to
#' specific models (like `gam`)
#' }
#'
#' For frequentist mixed models:
#' \itemize{
#' \item `algorithm`, for instance `"REML"` or `"ML"`
#' \item `optimizer`, name of optimizing function
#' }
#' - `algorithm`, for instance `"REML"` or `"ML"`
#' - `optimizer`, name of optimizing function
#'
#' For Bayesian models:
#' \itemize{
#' \item `algorithm`, the algorithm
#' \item `chains`, number of chains
#' \item `iterations`, number of iterations per chain
#' \item `warmup`, number of warmups per chain
#' }
#' - `algorithm`, the algorithm
#' - `chains`, number of chains
#' - `iterations`, number of iterations per chain
#' - `warmup`, number of warmups per chain
#'
#' @examples
#' if (require("lme4")) {
#' data(sleepstudy)
#' m <- lmer(Reaction ~ Days + (1 | Subject), data = sleepstudy)
#' find_algorithm(m)
#' }
#' @examplesIf require("lme4")
#' data(sleepstudy, package = "lme4")
#' m <- lme4::lmer(Reaction ~ Days + (1 | Subject), data = sleepstudy)
#' find_algorithm(m)
#'
#' @examplesIf require("rstanarm") && require("lme4")
#' \dontrun{
#' library(rstanarm)
#' m <- stan_lmer(Reaction ~ Days + (1 | Subject), data = sleepstudy)
#' data(sleepstudy, package = "lme4")
#' m <- suppressWarnings(rstanarm::stan_lmer(
#' Reaction ~ Days + (1 | Subject),
#' data = sleepstudy,
#' refresh = 0
#' ))
#' find_algorithm(m)
#' }
#' @export
Expand Down
24 changes: 16 additions & 8 deletions man/find_algorithm.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 2e95247

Please sign in to comment.