recordExtension: Record an extension and its version stamp on a mizer object

View source: R/registerExtensions.R

recordExtensionR Documentation

Record an extension and its version stamp on a mizer object

Description

Writes an entry for name into the object's ⁠@extensions⁠ slot, converting the slot to the versioned list form. Existing entries (and their version stamps) are preserved, keeping their position in the chain. A genuinely new entry is prepended to the front of the chain so that it stays ordered outermost-first, matching registerExtension(). The requirement is taken from the existing entry if present, otherwise from the registered extension chain.

Usage

recordExtension(params, name, version = NULL)

Arguments

params

A MizerParams object.

name

The extension identifier (its S4 marker class name).

version

Optional version string to stamp. If NULL (default) the existing stamp is preserved.

Details

Extension packages should call this instead of assigning to ⁠@extensions⁠ directly. Pass version (typically packageVersion(name)) only when the object has just been created or upgraded to conform to that version; leave it NULL for ordinary modifications so the existing stamp is preserved.

Value

The params object with the updated ⁠@extensions⁠ slot.

See Also

"Creating a mizer extension package": Creating a mizer extension package

Other extension tools: NOther(), clearExtensionChain(), coerceToExtensionClass(), getRegisteredExtensions(), initialNOther<-(), registerExtension(), registerExtensions(), setComponent(), setRateFunction()


mizer documentation built on Aug. 24, 2026, 9:08 a.m.