causalis.data_contracts.gate_contrast_estimate

Module Contents

Classes

GateContrastEstimate

Result contract for a post-estimation subgroup-effect contrast.

API

class causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate(/, **data: Any)

Bases: pydantic.BaseModel

Result contract for a post-estimation subgroup-effect contrast.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

model_config

‘ConfigDict(…)’

estimand: str

‘GATE_CONTRAST’

model: str

‘IRM’

model_options: Dict[str, Any]

‘Field(…)’

left_group: str

None

right_group: str

None

contrast_label: str

None

value: float

None

std_error: float

None

test_stat: float

None

p_value: float

None

ci_lower: Optional[float]

None

ci_upper: Optional[float]

None

alpha: float

None

alternative: str

‘two-sided’

is_significant: bool

None

left_value: float

None

right_value: float

None

n_left: int

None

n_right: int

None

time: str

‘Field(…)’

diagnostic_data: Optional[Dict[str, Any]]

None

summary() → pandas.DataFrame

Return a CausalEstimate-style summary for the requested contrast.