1% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/gam-tidiers.R
3\name{glance.Gam}
4\alias{glance.Gam}
5\title{Glance at a(n) Gam object}
6\usage{
7\method{glance}{Gam}(x, ...)
8}
9\arguments{
10\item{x}{A \code{Gam} object returned from a call to \code{\link[gam:gam]{gam::gam()}}.}
11
12\item{...}{Additional arguments. Not used. Needed to match generic
13signature only. \strong{Cautionary note:} Misspelled arguments will be
14absorbed in \code{...}, where they will be ignored. If the misspelled
15argument has a default value, the default value will be used.
16For example, if you pass \code{conf.lvel = 0.9}, all computation will
17proceed using \code{conf.level = 0.95}. Additionally, if you pass
18\code{newdata = my_tibble} to an \code{\link[=augment]{augment()}} method that does not
19accept a \code{newdata} argument, it will use the default value for
20the \code{data} argument.}
21}
22\description{
23Glance accepts a model object and returns a \code{\link[tibble:tibble]{tibble::tibble()}}
24with exactly one row of model summaries. The summaries are typically
25goodness of fit measures, p-values for hypothesis tests on residuals,
26or model convergence information.
27
28Glance never returns information from the original call to the modeling
29function. This includes the name of the modeling function or any
30arguments passed to the modeling function.
31
32Glance does not calculate summary measures. Rather, it farms out these
33computations to appropriate methods and gathers the results together.
34Sometimes a goodness of fit measure will be undefined. In these cases
35the measure will be reported as \code{NA}.
36
37Glance returns the same number of columns regardless of whether the
38model matrix is rank-deficient or not. If so, entries in columns
39that no longer have a well-defined value are filled in with an \code{NA}
40of the appropriate type.
41}
42\details{
43Glance at \code{gam} objects created by calls to \code{\link[mgcv:gam]{mgcv::gam()}} with
44\code{\link[=glance.gam]{glance.gam()}}.
45}
46\seealso{
47\code{\link[=glance]{glance()}}, \code{\link[gam:gam]{gam::gam()}}
48
49Other gam tidiers:
50\code{\link{tidy.Gam}()}
51}
52\concept{gam tidiers}
53\value{
54A \code{\link[tibble:tibble]{tibble::tibble()}} with exactly one row and columns:
55  \item{AIC}{Akaike's Information Criterion for the model.}
56  \item{BIC}{Bayesian Information Criterion for the model.}
57  \item{deviance}{Deviance of the model.}
58  \item{df}{Degrees of freedom used by the model.}
59  \item{df.residual}{Residual degrees of freedom.}
60  \item{logLik}{The log-likelihood of the model. [stats::logLik()] may be a useful reference.}
61  \item{nobs}{Number of observations used.}
62
63}
64