Skip to content

Commit

Permalink
fix examples
Browse files Browse the repository at this point in the history
  • Loading branch information
strengejacke committed Sep 22, 2023
1 parent 51fec86 commit 58dba81
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 16 deletions.
27 changes: 13 additions & 14 deletions R/get_variances.R
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,16 @@
#' @param ... Currently not used.
#'
#' @return A list with following elements:
#' \itemize{
#' \item `var.fixed`, variance attributable to the fixed effects
#' \item `var.random`, (mean) variance of random effects
#' \item `var.residual`, residual variance (sum of dispersion and distribution)
#' \item `var.distribution`, distribution-specific variance
#' \item `var.dispersion`, variance due to additive dispersion
#' \item `var.intercept`, the random-intercept-variance, or between-subject-variance (\ifelse{html}{\out{&tau;<sub>00</sub>}}{\eqn{\tau_{00}}})
#' \item `var.slope`, the random-slope-variance (\ifelse{html}{\out{&tau;<sub>11</sub>}}{\eqn{\tau_{11}}})
#' \item `cor.slope_intercept`, the random-slope-intercept-correlation (\ifelse{html}{\out{&rho;<sub>01</sub>}}{\eqn{\rho_{01}}})
#' \item `cor.slopes`, the correlation between random slopes (\ifelse{html}{\out{&rho;<sub>00</sub>}}{\eqn{\rho_{00}}})
#' }
#'
#' - `var.fixed`, variance attributable to the fixed effects
#' - `var.random`, (mean) variance of random effects
#' - `var.residual`, residual variance (sum of dispersion and distribution)
#' - `var.distribution`, distribution-specific variance
#' - `var.dispersion`, variance due to additive dispersion
#' - `var.intercept`, the random-intercept-variance, or between-subject-variance (\ifelse{html}{\out{&tau;<sub>00</sub>}}{\eqn{\tau_{00}}})
#' - `var.slope`, the random-slope-variance (\ifelse{html}{\out{&tau;<sub>11</sub>}}{\eqn{\tau_{11}}})
#' - `cor.slope_intercept`, the random-slope-intercept-correlation (\ifelse{html}{\out{&rho;<sub>01</sub>}}{\eqn{\rho_{01}}})
#' - `cor.slopes`, the correlation between random slopes (\ifelse{html}{\out{&rho;<sub>00</sub>}}{\eqn{\rho_{00}}})
#'
#' @details This function returns different variance components from mixed models,
#' which are needed, for instance, to calculate r-squared measures or the
Expand Down Expand Up @@ -97,10 +96,10 @@
#' }
#'
#' @note This function supports models of class `merMod` (including models
#' from \pkg{blme}), `clmm`, `cpglmm`, `glmmadmb`, `glmmTMB`,
#' from **blme**), `clmm`, `cpglmm`, `glmmadmb`, `glmmTMB`,
#' `MixMod`, `lme`, `mixed`, `rlmerMod`, `stanreg`,
#' `brmsfit` or `wbm`. Support for objects of class `MixMod`
#' (\pkg{GLMMadaptive}), `lme` (\pkg{nlme}) or `brmsfit` (\pkg{brms})
#' (**GLMMadaptive**), `lme` (**nlme**) or `brmsfit` (**brms**)
#' is experimental and may not work for all models.
#'
#' @references
Expand All @@ -117,7 +116,7 @@
#' and generalized linear mixed models with R. Newburgh, United Kingdom:
#' Highland Statistics.
#'
#' @examples
#' @examplesIf require("lme4", quietly = TRUE)
#' \donttest{
#' library(lme4)
#' data(sleepstudy)
Expand Down
6 changes: 4 additions & 2 deletions man/get_variance.Rd

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

0 comments on commit 58dba81

Please sign in to comment.