oups

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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),

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

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:

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:

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

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).

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

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.

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