cleverly.ParameterKey

class cleverly.ParameterKey(alias: str, estimand: str, axis: str = 'arm', value: Any = None, reference: Any = None, stratum: tuple[Any, ...] | None = None, regimen: str | None = None, horizon: int | None = None, cause: str | None = None, term: str | None = None)

Describe the structured identity behind a parameter alias.

Parameters:

aliasstr

Stable key used in result mappings.

estimandstr

Registered estimand name.

axisstr

Dimension indexed by value.

valueAny or None

Arm, intervention, or cell value.

referenceAny or None

Reference value used by a contrast.

stratumtuple or None

Target stratum values.

regimenstr or None

Longitudinal regimen label.

horizonint or None

Follow-up time.

causestr or None

Competing-risk cause label.

termstr or None

Marginal structural model term.

Methods

Attributes

ParameterKey.axis: str = 'arm'

ParameterKey.cause: str | None = None

ParameterKey.horizon: int | None = None

ParameterKey.reference: Any = None

ParameterKey.regimen: str | None = None

ParameterKey.stratum: tuple[Any, ...] | None = None

ParameterKey.term: str | None = None

ParameterKey.value: Any = None

ParameterKey.alias: str

ParameterKey.estimand: str