Set/get global afex options

Description

Global afex options are used, for example, by aov_car (et al.) and mixed. But can be changed in each functions directly using an argument (which has precedence over the global options).

Usage

1

Arguments

...

One of three: (1) nothing, then returns all options; (2) a name of an option element, then returns its' value; (3) a name-value pair which sets the corresponding option to the new value (and returns nothing).

Details

The following arguments are currently set:

  • check.contrasts should contrasts be checked and changed to sum-to-zero contrasts? Default is TRUE.

  • type type of sums-of-squares to be used for testing effects, default is 3 which reports Type 3 tests.

  • method_mixed: Method used to obtain p-values in mixed, default is "KR" (which will change to "LRT" soon). (mixed() only)

  • return_aov: Return value of the ANOVA functions (see aov_car), default is "nice".

  • es_aov: Effect size reported for ANOVAs (see aov_car), default is "ges" (generalized eta-squared).

  • correction_aov: Correction used for within-subjects factors with more than two levels for ANOVAs (see aov_car or nice), default is "GG" (Greenhouse-Geisser correction). (ANOVA functions only)

  • factorize: Should between subject factors be factorized (with note) before running the analysis? Default is TRUE. (ANOVA functions only)

Value

depends on input, see above.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
afex_options()

afex_options("return_aov")

afex_options("return_aov", "check.contrasts")  # returns only first value!

## Not run: 
afex_options(return_aov = "nice")

## End(Not run)