From 44974563aeecadf74ad67ff4d790c531d26e848b Mon Sep 17 00:00:00 2001 From: Joseph Larmarange Date: Fri, 23 Aug 2024 17:28:53 +0200 Subject: [PATCH] oups --- R/model_compute_terms_contributions.R | 2 +- R/model_get_assign.R | 2 +- R/model_get_coefficients_type.R | 2 +- R/model_get_contrasts.R | 2 +- R/model_get_model.R | 2 +- R/model_get_model_frame.R | 2 +- R/model_get_model_matrix.R | 2 +- R/model_get_n.R | 2 +- R/model_get_nlevels.R | 2 +- R/model_get_offset.R | 2 +- R/model_get_pairwise_contrasts.R | 2 +- R/model_get_response.R | 2 +- R/model_get_response_variable.R | 2 +- R/model_get_terms.R | 2 +- R/model_get_weights.R | 2 +- R/model_get_xlevels.R | 2 +- R/model_identify_variables.R | 2 +- R/model_list_contrasts.R | 2 +- R/model_list_higher_order_variables.R | 2 +- R/model_list_terms_levels.R | 2 +- R/model_list_variables.R | 2 +- R/scope_tidy.R | 2 +- R/tidy_and_attach.R | 2 ++ man/model_compute_terms_contributions.Rd | 2 +- man/model_get_assign.Rd | 2 +- man/model_get_coefficients_type.Rd | 2 +- man/model_get_contrasts.Rd | 2 +- man/model_get_model.Rd | 2 +- man/model_get_model_frame.Rd | 2 +- man/model_get_model_matrix.Rd | 6 +++--- man/model_get_n.Rd | 2 +- man/model_get_nlevels.Rd | 2 +- man/model_get_offset.Rd | 2 +- man/model_get_pairwise_contrasts.Rd | 6 +++--- man/model_get_response.Rd | 2 +- man/model_get_response_variable.Rd | 2 +- man/model_get_terms.Rd | 2 +- man/model_get_weights.Rd | 2 +- man/model_get_xlevels.Rd | 2 +- man/model_identify_variables.Rd | 2 +- man/model_list_contrasts.Rd | 2 +- man/model_list_higher_order_variables.Rd | 2 +- man/model_list_terms_levels.Rd | 6 +++--- man/model_list_variables.Rd | 6 +++--- man/scope_tidy.Rd | 2 +- man/tidy_attach_model.Rd | 3 +++ 46 files changed, 57 insertions(+), 52 deletions(-) diff --git a/R/model_compute_terms_contributions.R b/R/model_compute_terms_contributions.R index 52cbc510..b9f7cd84 100644 --- a/R/model_compute_terms_contributions.R +++ b/R/model_compute_terms_contributions.R @@ -9,7 +9,7 @@ #' @details #' This function does not cover `lavaan` models (`NULL` is returned). #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @export #' @family model_helpers diff --git a/R/model_get_assign.R b/R/model_get_assign.R index 2d6461bc..ecaaa5a9 100644 --- a/R/model_get_assign.R +++ b/R/model_get_assign.R @@ -3,7 +3,7 @@ #' Return the assign attribute attached to the object returned by #' [stats::model.matrix()]. #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @export #' @family model_helpers diff --git a/R/model_get_coefficients_type.R b/R/model_get_coefficients_type.R index adc1ab99..32d0de2b 100644 --- a/R/model_get_coefficients_type.R +++ b/R/model_get_coefficients_type.R @@ -3,7 +3,7 @@ #' Indicate the type of coefficient among "generic", "logistic", #' "poisson", "relative_risk" or "prop_hazard". #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @export #' @family model_helpers diff --git a/R/model_get_contrasts.R b/R/model_get_contrasts.R index 77ce26ef..5d7367fc 100644 --- a/R/model_get_contrasts.R +++ b/R/model_get_contrasts.R @@ -1,6 +1,6 @@ #' Get contrasts used in the model #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @export #' @family model_helpers diff --git a/R/model_get_model.R b/R/model_get_model.R index 21b67a43..0a235645 100644 --- a/R/model_get_model.R +++ b/R/model_get_model.R @@ -4,7 +4,7 @@ #' model objects that store the proper object internally (e.g. mice models). #' This function extracts that model object in those cases. #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @export #' @family model_helpers diff --git a/R/model_get_model_frame.R b/R/model_get_model_frame.R index e05538f9..9503923c 100644 --- a/R/model_get_model_frame.R +++ b/R/model_get_model_frame.R @@ -6,7 +6,7 @@ #' with the same data structure or `NULL` if it is not possible #' to compute model frame from `model`. #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @export #' @family model_helpers diff --git a/R/model_get_model_matrix.R b/R/model_get_model_matrix.R index 7618ab4b..75b70fb7 100644 --- a/R/model_get_model_matrix.R +++ b/R/model_get_model_matrix.R @@ -5,7 +5,7 @@ #' `model_get_model_matrix()` will always return an object #' with the same structure as [stats::model.matrix.default()]. #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @param ... Additional arguments passed to [stats::model.matrix()]. #' @export diff --git a/R/model_get_n.R b/R/model_get_n.R index 10e159b5..7e2d6297 100644 --- a/R/model_get_n.R +++ b/R/model_get_n.R @@ -20,7 +20,7 @@ #' #' This function does not cover `lavaan` models (`NULL` is returned). #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @export #' @family model_helpers diff --git a/R/model_get_nlevels.R b/R/model_get_nlevels.R index fc73e54d..7bf3cec3 100644 --- a/R/model_get_nlevels.R +++ b/R/model_get_nlevels.R @@ -1,6 +1,6 @@ #' Get the number of levels for each factor used in `xlevels` #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @return a tibble with two columns: `"variable"` and `"var_nlevels"` #' @export diff --git a/R/model_get_offset.R b/R/model_get_offset.R index de167960..73663e18 100644 --- a/R/model_get_offset.R +++ b/R/model_get_offset.R @@ -2,7 +2,7 @@ #' #' This function does not cover `lavaan` models (`NULL` is returned). #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @export #' @family model_helpers diff --git a/R/model_get_pairwise_contrasts.R b/R/model_get_pairwise_contrasts.R index c76d88d0..a9a9f658 100644 --- a/R/model_get_pairwise_contrasts.R +++ b/R/model_get_pairwise_contrasts.R @@ -2,7 +2,7 @@ #' #' It is computed with [emmeans::emmeans()]. #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @param variables ([`tidy-select`][dplyr::dplyr_tidy_select])\cr #' Variables to add pairwise contrasts. diff --git a/R/model_get_response.R b/R/model_get_response.R index d342c6c7..1098e24a 100644 --- a/R/model_get_response.R +++ b/R/model_get_response.R @@ -2,7 +2,7 @@ #' #' This function does not cover `lavaan` models (`NULL` is returned). #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @export #' @family model_helpers diff --git a/R/model_get_response_variable.R b/R/model_get_response_variable.R index 0e14129d..f6c0574b 100644 --- a/R/model_get_response_variable.R +++ b/R/model_get_response_variable.R @@ -1,6 +1,6 @@ #' Get the name of the response variable #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @export #' @family model_helpers diff --git a/R/model_get_terms.R b/R/model_get_terms.R index cdf64be1..84ba9fd1 100644 --- a/R/model_get_terms.R +++ b/R/model_get_terms.R @@ -3,7 +3,7 @@ #' Return the result of [stats::terms()] applied to the model #' or `NULL` if it is not possible to get terms from `model`. #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @export #' @family model_helpers diff --git a/R/model_get_weights.R b/R/model_get_weights.R index b5c36f64..5907a9e5 100644 --- a/R/model_get_weights.R +++ b/R/model_get_weights.R @@ -2,7 +2,7 @@ #' #' This function does not cover `lavaan` models (`NULL` is returned). #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @note #' For class `svrepglm` objects (GLM on a survey object with replicate weights), diff --git a/R/model_get_xlevels.R b/R/model_get_xlevels.R index 317e4c63..ceddf9dc 100644 --- a/R/model_get_xlevels.R +++ b/R/model_get_xlevels.R @@ -1,6 +1,6 @@ #' Get xlevels used in the model #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @export #' @family model_helpers diff --git a/R/model_identify_variables.R b/R/model_identify_variables.R index 1ddfbb7a..b1664613 100644 --- a/R/model_identify_variables.R +++ b/R/model_identify_variables.R @@ -1,7 +1,7 @@ #' Identify for each coefficient of a model the corresponding variable #' #' It will also identify interaction terms and intercept(s). -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @return #' A tibble with four columns: diff --git a/R/model_list_contrasts.R b/R/model_list_contrasts.R index e45b95df..c3cb8459 100644 --- a/R/model_list_contrasts.R +++ b/R/model_list_contrasts.R @@ -1,6 +1,6 @@ #' List contrasts used by a model #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @return #' A tibble with three columns: diff --git a/R/model_list_higher_order_variables.R b/R/model_list_higher_order_variables.R index 5d63e778..2158cb38 100644 --- a/R/model_list_higher_order_variables.R +++ b/R/model_list_higher_order_variables.R @@ -1,6 +1,6 @@ #' List higher order variables of a model #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @export #' @family model_helpers diff --git a/R/model_list_terms_levels.R b/R/model_list_terms_levels.R index ea83fb00..23cbad91 100644 --- a/R/model_list_terms_levels.R +++ b/R/model_list_terms_levels.R @@ -4,7 +4,7 @@ #' SAS, sum or successive differences contrasts (cf. [MASS::contr.sdif()]), and #' categorical variables with no contrast. #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @param label_pattern ([`glue pattern`][glue::glue()])\cr #' A [glue pattern][glue::glue()] for term labels (see examples). diff --git a/R/model_list_variables.R b/R/model_list_variables.R index 357d496f..18fa3fdd 100644 --- a/R/model_list_variables.R +++ b/R/model_list_variables.R @@ -2,7 +2,7 @@ #' #' Including variables used only in an interaction. #' -#' @param x (a model object, e.g. `glm`)\cr +#' @param model (a model object, e.g. `glm`)\cr #' A model object. #' @param labels (`list` or `string`)\cr #' An optional named list or named vector of diff --git a/R/scope_tidy.R b/R/scope_tidy.R index 8bb4f9ea..b75fc9d1 100644 --- a/R/scope_tidy.R +++ b/R/scope_tidy.R @@ -13,7 +13,7 @@ #' #' @param x (`data.frame`)\cr #' A tidy tibble, with a `"variable"` column, as returned by -#' [`tidy_identify_variables ()`]. +#' [`tidy_identify_variables()`]. #' @param data (`data.frame`)\cr #' An optional data frame the attributes will be added to. #' @return A data frame. diff --git a/R/tidy_and_attach.R b/R/tidy_and_attach.R index ef315eff..c58c4441 100644 --- a/R/tidy_and_attach.R +++ b/R/tidy_and_attach.R @@ -10,6 +10,8 @@ #' Use `tidy_get_model()` to get the model attached to the tibble and #' `tidy_detach_model()` to remove the attribute containing the model. #' @inheritParams tidy_plus_plus +#' @param x (`data.frame`)\cr +#' A tidy tibble as produced by `tidy_*()` functions. #' @param model_matrix_attr (`logical`)\cr #' Whether model frame and model matrix should be added as attributes of #' `model` (respectively named `"model_frame"` and `"model_matrix"`) and diff --git a/man/model_compute_terms_contributions.Rd b/man/model_compute_terms_contributions.Rd index 6ea60a62..d4fee298 100644 --- a/man/model_compute_terms_contributions.Rd +++ b/man/model_compute_terms_contributions.Rd @@ -10,7 +10,7 @@ model_compute_terms_contributions(model) \method{model_compute_terms_contributions}{default}(model) } \arguments{ -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} } \description{ diff --git a/man/model_get_assign.Rd b/man/model_get_assign.Rd index c44806c9..4e8db668 100644 --- a/man/model_get_assign.Rd +++ b/man/model_get_assign.Rd @@ -16,7 +16,7 @@ model_get_assign(model) \method{model_get_assign}{model_fit}(model) } \arguments{ -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} } \description{ diff --git a/man/model_get_coefficients_type.Rd b/man/model_get_coefficients_type.Rd index 31683807..4f7affec 100644 --- a/man/model_get_coefficients_type.Rd +++ b/man/model_get_coefficients_type.Rd @@ -64,7 +64,7 @@ model_get_coefficients_type(model) \method{model_get_coefficients_type}{LORgee}(model) } \arguments{ -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} } \description{ diff --git a/man/model_get_contrasts.Rd b/man/model_get_contrasts.Rd index 3e8c01a3..61256529 100644 --- a/man/model_get_contrasts.Rd +++ b/man/model_get_contrasts.Rd @@ -19,7 +19,7 @@ model_get_contrasts(model) \method{model_get_contrasts}{betareg}(model) } \arguments{ -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} } \description{ diff --git a/man/model_get_model.Rd b/man/model_get_model.Rd index 57e07949..6a7a8681 100644 --- a/man/model_get_model.Rd +++ b/man/model_get_model.Rd @@ -13,7 +13,7 @@ model_get_model(model) \method{model_get_model}{mira}(model) } \arguments{ -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} } \description{ diff --git a/man/model_get_model_frame.Rd b/man/model_get_model_frame.Rd index 15e8743e..6771f7dd 100644 --- a/man/model_get_model_frame.Rd +++ b/man/model_get_model_frame.Rd @@ -25,7 +25,7 @@ model_get_model_frame(model) \method{model_get_model_frame}{fixest}(model) } \arguments{ -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} } \description{ diff --git a/man/model_get_model_matrix.Rd b/man/model_get_model_matrix.Rd index d900e342..c3b25c10 100644 --- a/man/model_get_model_matrix.Rd +++ b/man/model_get_model_matrix.Rd @@ -46,10 +46,10 @@ model_get_model_matrix(model, ...) \method{model_get_terms}{cch}(model, ...) } \arguments{ -\item{...}{Additional arguments passed to \code{\link[stats:model.matrix]{stats::model.matrix()}}.} - -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} + +\item{...}{Additional arguments passed to \code{\link[stats:model.matrix]{stats::model.matrix()}}.} } \description{ The structure of the object returned by \code{\link[stats:model.matrix]{stats::model.matrix()}} diff --git a/man/model_get_n.Rd b/man/model_get_n.Rd index 07351a33..429ed6ac 100644 --- a/man/model_get_n.Rd +++ b/man/model_get_n.Rd @@ -34,7 +34,7 @@ model_get_n(model) \method{model_get_n}{tidycrr}(model) } \arguments{ -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} } \description{ diff --git a/man/model_get_nlevels.Rd b/man/model_get_nlevels.Rd index 5694f2cb..f25db42d 100644 --- a/man/model_get_nlevels.Rd +++ b/man/model_get_nlevels.Rd @@ -10,7 +10,7 @@ model_get_nlevels(model) \method{model_get_nlevels}{default}(model) } \arguments{ -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} } \value{ diff --git a/man/model_get_offset.Rd b/man/model_get_offset.Rd index 42643ee7..ae1c9445 100644 --- a/man/model_get_offset.Rd +++ b/man/model_get_offset.Rd @@ -10,7 +10,7 @@ model_get_offset(model) \method{model_get_offset}{default}(model) } \arguments{ -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} } \description{ diff --git a/man/model_get_pairwise_contrasts.Rd b/man/model_get_pairwise_contrasts.Rd index 3df9ec39..fb2d175d 100644 --- a/man/model_get_pairwise_contrasts.Rd +++ b/man/model_get_pairwise_contrasts.Rd @@ -14,6 +14,9 @@ model_get_pairwise_contrasts( ) } \arguments{ +\item{model}{(a model object, e.g. \code{glm})\cr +A model object.} + \item{variables}{(\code{\link[dplyr:dplyr_tidy_select]{tidy-select}})\cr Variables to add pairwise contrasts.} @@ -30,9 +33,6 @@ Level of confidence for confidence intervals (default: 95\%).} \item{emmeans_args}{(\code{logical})\cr List of additional parameter to pass to \code{\link[emmeans:emmeans]{emmeans::emmeans()}} when computing pairwise contrasts.} - -\item{x}{(a model object, e.g. \code{glm})\cr -A model object.} } \description{ It is computed with \code{\link[emmeans:emmeans]{emmeans::emmeans()}}. diff --git a/man/model_get_response.Rd b/man/model_get_response.Rd index 93765d07..8fa07cec 100644 --- a/man/model_get_response.Rd +++ b/man/model_get_response.Rd @@ -19,7 +19,7 @@ model_get_response(model) \method{model_get_response}{model_fit}(model) } \arguments{ -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} } \description{ diff --git a/man/model_get_response_variable.Rd b/man/model_get_response_variable.Rd index 42b9a0c8..1734d362 100644 --- a/man/model_get_response_variable.Rd +++ b/man/model_get_response_variable.Rd @@ -10,7 +10,7 @@ model_get_response_variable(model) \method{model_get_response_variable}{default}(model) } \arguments{ -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} } \description{ diff --git a/man/model_get_terms.Rd b/man/model_get_terms.Rd index 748e3378..f5caf80a 100644 --- a/man/model_get_terms.Rd +++ b/man/model_get_terms.Rd @@ -24,7 +24,7 @@ model_get_terms(model) \method{model_get_terms}{betareg}(model) } \arguments{ -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} } \description{ diff --git a/man/model_get_weights.Rd b/man/model_get_weights.Rd index 5b68c1d3..8de20cfe 100644 --- a/man/model_get_weights.Rd +++ b/man/model_get_weights.Rd @@ -19,7 +19,7 @@ model_get_weights(model) \method{model_get_weights}{model_fit}(model) } \arguments{ -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} } \description{ diff --git a/man/model_get_xlevels.Rd b/man/model_get_xlevels.Rd index d92bc3a6..494df97e 100644 --- a/man/model_get_xlevels.Rd +++ b/man/model_get_xlevels.Rd @@ -31,7 +31,7 @@ model_get_xlevels(model) \method{model_get_xlevels}{model_fit}(model) } \arguments{ -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} } \description{ diff --git a/man/model_identify_variables.Rd b/man/model_identify_variables.Rd index 0bfb41dd..dbf1d46c 100644 --- a/man/model_identify_variables.Rd +++ b/man/model_identify_variables.Rd @@ -31,7 +31,7 @@ model_identify_variables(model) \method{model_identify_variables}{logitr}(model) } \arguments{ -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} } \value{ diff --git a/man/model_list_contrasts.Rd b/man/model_list_contrasts.Rd index 6abd2661..6f0e5455 100644 --- a/man/model_list_contrasts.Rd +++ b/man/model_list_contrasts.Rd @@ -10,7 +10,7 @@ model_list_contrasts(model) \method{model_list_contrasts}{default}(model) } \arguments{ -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} } \value{ diff --git a/man/model_list_higher_order_variables.Rd b/man/model_list_higher_order_variables.Rd index 07fdbbe2..fdda8848 100644 --- a/man/model_list_higher_order_variables.Rd +++ b/man/model_list_higher_order_variables.Rd @@ -10,7 +10,7 @@ model_list_higher_order_variables(model) \method{model_list_higher_order_variables}{default}(model) } \arguments{ -\item{x}{(a model object, e.g. \code{glm})\cr +\item{model}{(a model object, e.g. \code{glm})\cr A model object.} } \description{ diff --git a/man/model_list_terms_levels.Rd b/man/model_list_terms_levels.Rd index 00b45908..5330481c 100644 --- a/man/model_list_terms_levels.Rd +++ b/man/model_list_terms_levels.Rd @@ -20,6 +20,9 @@ model_list_terms_levels( ) } \arguments{ +\item{model}{(a model object, e.g. \code{glm})\cr +A model object.} + \item{label_pattern}{(\code{\link[glue:glue]{glue pattern}})\cr A \link[glue:glue]{glue pattern} for term labels (see examples).} @@ -30,9 +33,6 @@ custom variable labels passed to \code{\link[=model_list_variables]{model_list_v \item{sdif_term_level}{(\code{string})\cr For successive differences contrasts, how should term levels be named? \code{"diff"} for \code{"B - A"} (default), \code{"ratio"} for \code{"B / A"}.} - -\item{x}{(a model object, e.g. \code{glm})\cr -A model object.} } \value{ A tibble with ten columns: diff --git a/man/model_list_variables.Rd b/man/model_list_variables.Rd index 0e1376dc..41c2949e 100644 --- a/man/model_list_variables.Rd +++ b/man/model_list_variables.Rd @@ -36,6 +36,9 @@ model_list_variables( ) } \arguments{ +\item{model}{(a model object, e.g. \code{glm})\cr +A model object.} + \item{labels}{(\code{list} or \code{string})\cr An optional named list or named vector of custom variable labels.} @@ -45,9 +48,6 @@ If \code{TRUE}, will return only "variable" column.} \item{add_var_type}{(\code{logical})\cr If \code{TRUE}, add \code{var_nlevels} and \code{var_type} columns.} - -\item{x}{(a model object, e.g. \code{glm})\cr -A model object.} } \value{ A tibble with three columns: diff --git a/man/scope_tidy.Rd b/man/scope_tidy.Rd index 0c02dae6..0ec99a41 100644 --- a/man/scope_tidy.Rd +++ b/man/scope_tidy.Rd @@ -9,7 +9,7 @@ scope_tidy(x, data = NULL) \arguments{ \item{x}{(\code{data.frame})\cr A tidy tibble, with a \code{"variable"} column, as returned by -\code{\link[=tidy_identify_variables ]{tidy_identify_variables ()}}.} +\code{\link[=tidy_identify_variables]{tidy_identify_variables()}}.} \item{data}{(\code{data.frame})\cr An optional data frame the attributes will be added to.} diff --git a/man/tidy_attach_model.Rd b/man/tidy_attach_model.Rd index cecbf1ee..271fcc2f 100644 --- a/man/tidy_attach_model.Rd +++ b/man/tidy_attach_model.Rd @@ -24,6 +24,9 @@ tidy_get_model(x) tidy_detach_model(x) } \arguments{ +\item{x}{(\code{data.frame})\cr +A tidy tibble as produced by \verb{tidy_*()} functions.} + \item{model}{(a model object, e.g. \code{glm})\cr A model to be attached/tidied.}