diff --git a/R/get_df.R b/R/get_df.R index c596724ec..81b5374db 100644 --- a/R/get_df.R +++ b/R/get_df.R @@ -5,8 +5,8 @@ #' from regression models. #' #' @param x A statistical model. -#' @param type Can be `"residual"`, `"wald"`, `"normal"`, or -#' `"model"`. `"analytical"` is an alias for `"residual"`. +#' @param type Type of approximation for the degrees of freedom. Can be one of +#' the following: #' #' + `"residual"` (aka `"analytical"`) returns the residual degrees of #' freedom, which usually is what [`stats::df.residual()`] returns. If a diff --git a/man/get_df.Rd b/man/get_df.Rd index 7577f207e..f6478db55 100644 --- a/man/get_df.Rd +++ b/man/get_df.Rd @@ -14,8 +14,8 @@ get_df(x, ...) \item{...}{Currently not used.} -\item{type}{Can be \code{"residual"}, \code{"wald"}, \code{"normal"}, or -\code{"model"}. \code{"analytical"} is an alias for \code{"residual"}. +\item{type}{Type of approximation for the degrees of freedom. Can be one of +the following: \itemize{ \item \code{"residual"} (aka \code{"analytical"}) returns the residual degrees of freedom, which usually is what \code{\link[stats:df.residual]{stats::df.residual()}} returns. If a