Skip to contents

Instantiate a template into per-subject jobs

Source: R/instantiate.R
instantiate.Rd

Binds an fmri_template to one or more per-subject data bindings, producing serializable fmri_job recipes. No data is loaded: file-backed scans are kept as paths and realized lazily by run().

Usage

instantiate(template, x, ...)

Arguments

template

An fmri_template.

x

A single binding (a named list with at least id), a list of bindings, or a manifest data.frame (one row per analysis unit, with list-columns for scans/events/run_length/etc.).

...

Unused.

Value

A single fmri_job if x is one binding, otherwise a list of fmri_jobs.

See also

fmri_job(), run(), from_bids()

Examples

tmpl <- fmri_template(onset ~ hrf(condition), ~ run)
b <- list(id = "sub-01", scans = matrix(rnorm(80 * 3), 80, 3),
          TR = 2, run_length = c(40, 40),
          events = data.frame(onset = c(5, 25, 45, 65),
                              condition = factor(c("A", "B", "A", "B")),
                              run = c(1, 1, 2, 2)))
job <- instantiate(tmpl, b)