Skip to contents

Register a plugin engine for fmri_lm

Source: R/aaa_plugin_api.R
register_engine.Rd

Register a plugin engine for fmri_lm

Usage

register_engine(name, fit, preflight = NULL, capabilities = list())

Arguments

name

Character scalar identifier advertised to users (e.g. "friman").

fit

Function invoked as fit(model, dataset, args, cfg) and expected to return an fmri_lm object.

preflight

Optional function invoked before fitting; receives the same arguments as fit and can signal errors early.

capabilities

Optional named list describing the engine (for future use).

Value

Invisibly, TRUE.