Description Usage Arguments Details Value Author(s) References See Also Examples
summ()
prints output for a regression model in a fashion similar to
summary()
, but formatted differently with more options.
1 2 3 4 5 6 7 8 9 10 11 12 13  ## S3 method for class 'merMod'
summ(model, scale = FALSE,
confint = getOption("summconfint", FALSE),
ci.width = getOption("summci.width", 0.95),
conf.method = getOption("summconf.method", c("Wald", "profile",
"boot")), digits = getOption("jtoolsdigits", default = 2),
r.squared = TRUE, pvals = getOption("summpvals", NULL), n.sd = 1,
center = FALSE, transform.response = FALSE, data = NULL,
exp = FALSE, t.df = NULL, model.info = getOption("summmodel.info",
TRUE), model.fit = getOption("summmodel.fit", TRUE),
re.variance = getOption("summre.variance", c("sd", "var")),
which.cols = NULL, re.table = getOption("summre.table", TRUE),
groups.table = getOption("summgroups.table", TRUE), ...)

model 
A 
scale 
If 
confint 
Show confidence intervals instead of standard errors? Default
is 
ci.width 
A number between 0 and 1 that signifies the width of the
desired confidence interval. Default is 
conf.method 
Argument passed to 
digits 
An integer specifying the number of digits past the decimal to
report in the output. Default is 2. You can change the default number of
digits for all jtools functions with

r.squared 
Calculate an rsquared model fit statistic? Default is

pvals 
Show p values? If 
n.sd 
If 
center 
If you want coefficients for meancentered variables but don't
want to standardize, set this to 
transform.response 
Should scaling/centering apply to response
variable? Default is 
data 
If you provide the data used to fit the model here, that data
frame is used to refit the model (if 
exp 
If 
t.df 
For 
model.info 
Toggles printing of basic information on sample size, name of DV, and number of predictors. 
model.fit 
Toggles printing of model fit statistics. 
re.variance 
Should random effects variances be expressed in
standard deviations or variances? Default, to be consistent with previous
versions of 
which.cols 
Developmental feature. By providing columns by name, you can add/remove/reorder requested columns in the output. Not fully supported, for now. 
re.table 
Show table summarizing variance of random effects? Default is TRUE. 
groups.table 
Show table summarizing the grouping variables? Default is TRUE. 
... 
Among other things, arguments are passed to 
By default, this function will print the following items to the console:
The sample size
The name of the outcome variable
The (Pseudo)Rsquared value and AIC/BIC.
A table with regression coefficients, standard errors, and tvalues.
The scale
and center
options are performed via refitting
the model with scale_mod()
and center_mod()
,
respectively. Each of those in turn uses gscale()
for the
meancentering and scaling.
merMod
models are a bit different than the others. The lme4
package developers have, for instance, made a decision not to report or
compute p values for lmer()
models. There are good reasons for this,
most notably that the tvalues produced are not "accurate" in the sense of
the Type I error rate. For certain large, balanced samples with many
groups, this is no big deal. What's
a "big" or "small" sample? How much balance is necessary? What type of
random effects structure is okay? Good luck getting a statistician to
give you any clear guidelines on this.
Some simulation studies have been done on fewer than 100 observations, so
for sure if your sample is around 100 or fewer you should not interpret
the tvalues. A large number of groups is also crucial for avoiding bias
using tvalues. If groups are nested or crossed in a linear model,
it is best to just get the pbkrtest package.
By default, this function follows lme4
's lead and does not report
the p values for lmer()
models. If the user has pbkrtest
installed, however, p values are reported using the KenwardRoger
d.f. approximation unless pvals = FALSE
or t.df
is
set to something other than NULL
. In publications,
you should cite the
Kenward & Roger (1997) piece as well as either this package or
pbkrtest package to explain how the p values were calculated.
See pvalues
from the lme4 for more details.
If you're looking for a simple test with no extra packages installed,
it is better to use the confidence
intervals and check to see if they exclude zero than use the ttest.
For users of glmer()
, see some of the advice there as well. While
lme4
and by association summ()
does as well, they are
still imperfect.
You have some options to customize the output in this regard with the
t.df
argument. If NULL
, the default, the
degrees of freedom used depends on whether the user has
lmerTest or pbkrtest installed. If lmerTest
is installed,
the degrees of freedom for each coefficient are calculated using the
Satterthwaite method and the p values calculated accordingly.
If only pbkrtest
is installed or t.df
is "kr"
, the KenwardRoger
approximation of the standard errors and degrees of freedom for each
coefficient is used. Note that KenwardRoger standard errors can take
longer to calculate and may cause R to crash with models fit to large
(roughly greater than 5000 rows) datasets.
If neither is installed and the user sets
pvals = TRUE
, then the residual degrees of freedom
is used. If t.df = "residual"
, then the residual d.f. is used
without a message. If the user prefers to use some other method to
determine the d.f., then any number provided as the argument will be
used.
About pseudoR^2
There is no one way to calculate R^2 for mixed models or nonlinear models. Many caution against interpreting or even using such approximations outside of OLS regression. With that said, this package reports one version for your benefit, though you should of course understand that it is not an unambiguous measure of model fit.
This package calculates R^2 for mixed models using an adapted version
of sem.model.fits()
from the piecewiseSEM
package. This is an implementation of the Nakagawa & Schielzeth (2013)
procedure with refinements by Johnson (2014). If you choose to report
the pseudoR^2 in a publication, you should cite Nakagawa & Schielzeth
to explain how the calculation was done.
If saved, users can access most of the items that are returned in the output (and without rounding).
coeftable 
The outputted table of variables and coefficients 
rcoeftable 
The secondary table with the grouping variables and random coefficients. 
gvars 
The tertiary table with the grouping variables, numbers of groups, and ICCs. 
model 
The model for which statistics are displayed. This would be
most useful in cases in which 
Much other information can be accessed as attributes.
Jacob Long <[email protected]>
Johnson, P. C. D. (2014). Extension of Nakagawa & Schielzeth's $R^2_GLMM$ to random slopes models. Methods in Ecology and Evolution, 5, 944–946. https://doi.org/10.1111/2041210X.12225
Kenward, M. G., & Roger, J. H. (1997). Small sample inference for fixed effects from restricted maximum likelihood. Biometrics, 53, 983. https://doi.org/10.2307/2533558
Kuznetsova, A., Brockhoff, P. B., & Christensen, R. H. B. (2017). lmerTest package: Tests in linear mixed effects models. Journal of Statistical Software, 82. https://doi.org/10.18637/jss.v082.i13
Luke, S. G. (2017). Evaluating significance in linear mixedeffects models in R. Behavior Research Methods, 49, 1494–1502. https://doi.org/10.3758/s134280160809y
Nakagawa, S., & Schielzeth, H. (2013). A general and simple method for obtaining $R^2$ from generalized linear mixedeffects models. Methods in Ecology and Evolution, 4, 133–142. https://doi.org/10.1111/j.2041210x.2012.00261.x
scale_mod()
can simply perform the standardization if
preferred.
gscale()
does the heavy lifting for meancentering and scaling
behind the scenes.
pbkrtest::get_ddf_Lb()
gets the KenwardRoger degrees of
freedom if you have pbkrtest installed.
A tweaked version of piecewiseSEM::sem.model.fits()
is used to
generate the pseudoRsquared estimates for linear models.
Other summ: summ.glm
, summ.lm
,
summ.rq
, summ.svyglm
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19  if (requireNamespace("lme4")) {
library(lme4, quietly = TRUE)
data(sleepstudy)
mv < lmer(Reaction ~ Days + (Days  Subject), sleepstudy)
summ(mv) # Note lack of p values if you don't have lmerTest/pbkrtest
# Without lmerTest/pbkrtest, you'll get message about Type 1 errors
summ(mv, pvals = TRUE)
# To suppress message, manually specify t.df argument
summ(mv, t.df = "residual")
# Confidence intervals may be better alternative to p values
summ(mv, confint = TRUE)
# Use conf.method to get profile intervals (may be slow to run)
# summ(mv, confint = TRUE, conf.method = "profile")
}

Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.