More linking in docs

R/centrality-description.R

@@ -7,7 +7,7 @@
 #' grouping variable in `x` by a set of indices (e.g., measures of centrality,
 #' dispersion, range, skewness, kurtosis, etc.). It additionally returns an
 #' expression containing a specified centrality measure. The function internally
-#' relies on `datawizard::describe_distribution()` function.
+#' relies on [`datawizard::describe_distribution()`] function.
 #'
 #' @description
 #' Parametric, non-parametric, robust, and Bayesian measures of centrality.

R/contingency-table.R

@@ -25,10 +25,12 @@
 #'   represents a single observation.
 #' @param paired Logical indicating whether data came from a within-subjects or
 #'   repeated measures design study (Default: `FALSE`).
-#' @param sampling.plan Character describing the sampling plan. Possible options
-#'   are `"indepMulti"` (independent multinomial; default), `"poisson"`,
-#'   `"jointMulti"` (joint multinomial), `"hypergeom"` (hypergeometric). For
-#'   more, see `?BayesFactor::contingencyTableBF()`.
+#' @param sampling.plan Character describing the sampling plan. Possible options:
+#'   - `"indepMulti"` (independent multinomial; default)
+#'   - `"poisson"`
+#'   - `"jointMulti"` (joint multinomial)
+#'   - `"hypergeom"` (hypergeometric).
+#'   For more, see [`BayesFactor::contingencyTableBF()`].
 #' @param fixed.margin For the independent multinomial sampling plan, which
 #'   margin is fixed (`"rows"` or `"cols"`). Defaults to `"rows"`.
 #' @param prior.concentration Specifies the prior concentration parameter, set

R/helpers-easystats.R

@@ -46,7 +46,7 @@ tidy_model_parameters <- function(model, ...) {
 
 
 #' @name tidy_model_effectsize
-#' @title Convert `effectsize` package output to `tidyverse` conventions
+#' @title Convert `{effectsize}` package output to `{tidyverse}` conventions
 #'
 #' @param data A data frame returned by `{effectsize}` functions.
 #' @param ... Currently ignored.

R/meta-analysis.R

@@ -7,10 +7,9 @@
 #' @param data A data frame. It **must** contain columns named `estimate` (effect
 #'   sizes or outcomes)  and `std.error` (corresponding standard errors). These
 #'   two columns will be used:
-#'   - as `yi`  and `sei` arguments in `metafor::rma()` (for **parametric** test)
-#'   or `metaplus::metaplus()` (for **robust** test)
-#'   - as `y` and `SE` arguments in `metaBMA::meta_random()` (for **Bayesian**
-#'   test).
+#'   - as `yi`  and `sei` arguments in [`metafor::rma()`] (for **parametric** test)
+#'   - as `yi`  and `sei` arguments in [`metaplus::metaplus()`] (for **robust** test)
+#'   - as `y` and `SE` arguments in [`metaBMA::meta_random()`] (for **Bayesian** test)
 #' @inheritParams one_sample_test
 #' @inheritParams metaplus::metaplus
 #' @inheritParams oneway_anova

R/oneway-anova.R

@@ -34,8 +34,8 @@
 #'   width to use in calculating Bayes factors and posterior estimates. In
 #'   addition to numeric arguments, several named values are also recognized:
 #'   `"medium"`, `"wide"`, and `"ultrawide"`, corresponding to *r* scale values
-#'   of 1/2, sqrt(2)/2, and 1, respectively. In case of an ANOVA, this value
-#'   corresponds to scale for fixed effects.
+#'   of `1/2`, `sqrt(2)/2`, and `1`, respectively. In case of an ANOVA, this
+#'   value corresponds to scale for fixed effects.
 #' @inheritParams two_sample_test
 #' @inheritParams add_expression_col
 #' @param ... Additional arguments (currently ignored).

R/tidy-model-expressions.R

@@ -3,7 +3,7 @@
 #'
 #' @param ... Currently ignored.
 #' @param data A tidy data frame from regression model object (see
-#'   `statsExpressions::tidy_model_parameters()`).
+#'   [`statsExpressions::tidy_model_parameters()`]).
 #' @param statistic Which statistic is to be displayed (either `"t"` or `"f"`or
 #'   `"z"` or `"chi"`) in the expression.
 #' @inheritParams oneway_anova