Skip to contents

Get options for an experiment

Source: R/get_exp_opts.R
get_exp_opts.Rd

Get options for an experiment

Usage

get_exp_opts(iterations = 1, miniblocks = TRUE)

Arguments

iterations

Numeric denoting the number of iterations to run. Default = 1.

miniblocks

A logical denoting whether to create trial miniblocks when possible. Default = TRUE.

Value

A list with default or user-given options.

Note

The miniblocks option will direct the sampling function to create equally-sized miniblocks with random trials within a phase. For example, the phase string "2A/2B" will create two miniblocks with one of each trial. The phase string "2A/4B" will create two miniblocks with one A trial, and 2 B trials. However, the phase string "2A/1B" will not result in miniblocks, even if miniblocks here is set to TRUE.

See also

make_experiment

Examples

get_exp_opts(iterations = 10)
#> $iterations
#> [1] 10
#> 
#> $miniblocks
#> [1] TRUE
#>