simrOptions: Options Settings for 'simr'

In simr: Power Analysis for Generalised Linear Mixed Models by Simulation

Options Settings for simr

Description

Control the default behaviour of simr analyses.

Usage

simrOptions(...)

getSimrOption(opt)

Arguments

...	a list of names to get options, or a named list of new values to set options.
opt	option name (character string).

Value

getSimrOption returns the current value for the option x.

simrOptions returns

1. a named list of all options, if no arguments are given.

2. a named list of specified options, if a list of option names is given.

3. (invisibly) a named list of changed options with their previous values, if options are set.

Options in simr

Options that can be set with this method (and their default values).

nsim

default number of simulations (1000).

alpha

default confidence level (0.05).

progress

use progress bars during calculations (TRUE).

binom

method for calculating confidence intervals ("exact").

pbnsim

number of simulations for parametric bootstrap tests using pbkrtest (100).

pcmin

minimum number of levels for the smallest point on a powerCurve (3).

pcmax

maximum number of points on the default powerCurve (10).

observedPowerWarning

warn if an unmodified fitted model is used (TRUE).

carTestType

type of test, i.e. type of sum of squares, for tests performed with car::Anova ("II").

lmerTestDdf

approximation to use for denominator degrees of freedom for tests performed with lmerTest ("Satterthwaite"). Note that setting this option to "lme4" will reduce the lmerTest model to an lme4 model and break functionality based on lmerTest.

lmerTestType

type of test, i.e. type of sum of squares, for F-tests performed with lmerTest::anova.lmerModLmerTest (2). Note that unlike the tests performed with car::Anova, the test type must be given as a number and not a character.

Examples

getSimrOption("nsim")
oldopts <- simrOptions(nsim=5)
getSimrOption("nsim")
simrOptions(oldopts)
getSimrOption("nsim")

simr documentation built on Aug. 19, 2025, 1:13 a.m.