Glance accepts a model object and returns a tibble::tibble()
with exactly one row of model summaries. The summaries are typically
goodness of fit measures, p-values for hypothesis tests on residuals,
or model convergence information.
Glance never returns information from the original call to the modeling function. This includes the name of the modeling function or any arguments passed to the modeling function.
Glance does not calculate summary measures. Rather, it farms out these
computations to appropriate methods and gathers the results together.
Sometimes a goodness of fit measure will be undefined. In these cases
the measure will be reported as NA
.
Glance returns the same number of columns regardless of whether the
model matrix is rank-deficient or not. If so, entries in columns
that no longer have a well-defined value are filled in with an NA
of the appropriate type.
# S3 method for svyglm
glance(x, maximal = x, ...)
A svyglm
object returned from survey::svyglm()
.
A svyglm
object corresponding to the maximal
model against which to compute the BIC. See Lumley and Scott
(2015) for details. Defaults to x
, which is equivalent
to not using a maximal model.
Additional arguments. Not used. Needed to match generic
signature only. Cautionary note: Misspelled arguments will be
absorbed in ...
, where they will be ignored. If the misspelled
argument has a default value, the default value will be used.
For example, if you pass conf.lvel = 0.9
, all computation will
proceed using conf.level = 0.95
. Additionally, if you pass
newdata = my_tibble
to an augment()
method that does not
accept a newdata
argument, it will use the default value for
the data
argument.
Lumley T, Scott A (2015). AIC and BIC for modelling with complex survey data. Journal of Survey Statistics and Methodology, 3(1).
survey::svyglm()
, stats::glm()
, survey::anova.svyglm
Other lm tidiers:
augment.glm()
,
augment.lm()
,
glance.glm()
,
glance.lm()
,
glance.summary.lm()
,
tidy.glm()
,
tidy.lm.beta()
,
tidy.lm()
,
tidy.mlm()
,
tidy.summary.lm()
A tibble::tibble()
with exactly one row and columns:
Akaike's Information Criterion for the model.
Bayesian Information Criterion for the model.
Deviance of the model.
Degrees of freedom used by the null model.
Residual degrees of freedom.
Deviance of the null model.
# feel free to ignore the following line—it allows {broom} to supply
# examples without requiring the model-supplying package to be installed.
if (requireNamespace("survey", quietly = TRUE)) {
# load libraries for models and data
library(survey)
set.seed(123)
data(api)
# survey design
dstrat <-
svydesign(
id = ~1,
strata = ~stype,
weights = ~pw,
data = apistrat,
fpc = ~fpc
)
# model
m <- svyglm(
formula = sch.wide ~ ell + meals + mobility,
design = dstrat,
family = quasibinomial()
)
glance(m)
}
#> Loading required package: grid
#>
#> Attaching package: ‘survey’
#> The following object is masked from ‘package:drc’:
#>
#> twophase
#> The following object is masked from ‘package:graphics’:
#>
#> dotchart
#> # A tibble: 1 × 7
#> null.deviance df.null AIC BIC deviance df.residual nobs
#> <dbl> <int> <dbl> <dbl> <dbl> <dbl> <int>
#> 1 184. 199 184. 199. 178. 194 200