Skip to content

Commit

Permalink
roxygenized
Browse files Browse the repository at this point in the history
- also fixed typesetting of eta-squared in docs of apa_print.<anova-objects>
  • Loading branch information
mariusbarth committed Sep 30, 2023
1 parent 2c0611e commit 9eb5b49
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 21 deletions.
8 changes: 4 additions & 4 deletions R/apa_print_anova.R
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
#' It is `FALSE` if the \pkg{effectsize} package is installed and `TRUE` if it
#' is not installed. This can be changed either by supplying a different value
#' in the function call or by changing the global default via
#' `options(papaja.mse = FALSE)`.
#' `options(papaja.mse = ...)`.
#' @param observed Character. The names of the factors that are observed,
#' i.e., not manipulated. Necessary only for calculating *generalized* eta
#' squared; otherwise ignored. If `x` is of class `afex_aov`, `observed` is
Expand All @@ -32,9 +32,9 @@
#'
#' Argument `estimate` determines which measure of effect size is to be used:
#' It is currently possible to provide one of three characters to specify the
#' to-be-calculated effect size: \code{"ges"} for generalized \eqn{eta^2},
#' \code{"pes"} for partial \eqn{eta^2}, and \code{"es"} for \eqn{eta^2}.
#' Note that \eqn{eta^2} is calculated correctly if and only if the design is
#' to-be-calculated effect size: `"ges"` for generalized \eqn{\eta^2},
#' \code{"pes"} for partial \eqn{\eta^2}, and `"es"` for \eqn{\eta^2}.
#' Note that \eqn{\eta^2} is calculated correctly if and only if the design is
#' balanced.
#'
#' It is also possible to provide a `data.frame` with columns `estimate`,
Expand Down
4 changes: 1 addition & 3 deletions man/add_effect_sizes.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 16 additions & 14 deletions man/apa_print.aov.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 9eb5b49

Please sign in to comment.