make_experiment: Make CalmrExperiment

In calmr: Canonical Associative Learning Models and their Representations

Make CalmrExperiment

Description

Makes a CalmrExperiment object containing the arguments necessary to run an experiment.

Usage

make_experiment(
  design,
  model,
  parameters = NULL,
  timings = NULL,
  iterations = 1,
  miniblocks = TRUE,
  seed = NULL,
  .callback_fn = NULL,
  ...
)

Arguments

design	A design data.frame.
model	A string specifying the model name. One of supported_models().
parameters	Optional. Parameters for a model as returned by get_parameters().
timings	Optional. Timings for a time-based design as returned by get_timings()
iterations	An integer specifying the number of iterations per group. Default = 1.
miniblocks	Whether to organize trials in miniblocks. Default = TRUE.
seed	A valid seed for the RNG to make the experiment. Default = NULL, in which case the current RNG is used.
.callback_fn	A function for keeping track of progress. Internal use.
...	Extra parameters passed to other functions.

Value

A CalmrExperiment object.

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

parse_design(),

Examples

des <- data.frame(Group = "G1", P1 = "10A>(US)")
ps <- get_parameters(des, model = "HD2022")
make_experiment(
  design = des, parameters = ps,
  model = "HD2022", iterations = 2
)

calmr documentation built on June 8, 2025, 1:03 p.m.