diff --git a/R/tidy_select_variables.R b/R/tidy_select_variables.R index 1ff41cde..4c8ce4d9 100644 --- a/R/tidy_select_variables.R +++ b/R/tidy_select_variables.R @@ -11,6 +11,9 @@ #' syntax. Use `-` to remove a variable. Default is `everything()`. #' See also [all_continuous()], [all_categorical()], [all_dichotomous()] #' and [all_interaction()] +#' @return +#' The `x` tibble limited to the included variables (and eventually the intercept), +#' sorted according to the `include` parameter. #' #' @param model the corresponding model, if not attached to `x` #' @export diff --git a/man/tidy_select_variables.Rd b/man/tidy_select_variables.Rd index d97bd593..6fa42102 100644 --- a/man/tidy_select_variables.Rd +++ b/man/tidy_select_variables.Rd @@ -16,6 +16,10 @@ and \code{\link[=all_interaction]{all_interaction()}}} \item{model}{the corresponding model, if not attached to \code{x}} } +\value{ +The \code{x} tibble limited to the included variables (and eventually the intercept), +sorted according to the \code{include} parameter. +} \description{ Will remove unselected variables from the results. To remove the intercept, use \code{\link[=tidy_remove_intercept]{tidy_remove_intercept()}}.