Skip to content
Submodule
causalis.data_contracts.causaldata_instrumental

causaldata_instrumental

Submodule causalis.data_contracts.causaldata_instrumental with no child pages and 6 documented members.

Symbol indexAPI membersCausalDataInstrumentalinstrument_namefrom_dfinstrument

Classes

Jump directly into the documented classes for this page.

1 items
CausalDataInstrumentalclass
class
causalis.data_contracts.causaldata_instrumental.CausalDataInstrumental

CausalDataInstrumental

Bases: causalis.data_contracts.causaldata.CausalData

Container for causal inference datasets with causaldata_instrumental variables.

Attributes

instrument_namestr

Column name representing the causaldata_instrumental variable.

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.

Canonical target

causalis.data_contracts.causaldata_instrumental.CausalDataInstrumental

Sections

AttributesInitialization
Link to this symbol
attribute
causalis.data_contracts.causaldata_instrumental.CausalDataInstrumental.instrument_name

instrument_name

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.causaldata_instrumental.CausalDataInstrumental.instrument_name

Link to this symbol
method
causalis.data_contracts.causaldata_instrumental.CausalDataInstrumental.from_df

from_df

Friendly constructor for CausalDataInstrumental.

Parameters

dfpd.DataFrame

The DataFrame containing the data_contracts.

treatmentstr

Column name representing the treatment variable.

outcomestr

Column name representing the outcome variable.

confoundersUnion[str, List[str]], optional

Column name(s) representing the confounders/covariates.

user_idstr, optional

Column name representing the unique identifier for each observation/user.

instrumentstr, optional

Column name representing the causaldata_instrumental variable.

**kwargsAny

Additional arguments passed to the Pydantic model constructor.

Returns

CausalDataInstrumental

A validated CausalDataInstrumental instance.

Canonical target

causalis.data_contracts.causaldata_instrumental.CausalDataInstrumental.from_df

Sections

ParametersReturns
Link to this symbol
property
causalis.data_contracts.causaldata_instrumental.CausalDataInstrumental.instrument

instrument

instrument column as a Series.

Returns

pd.Series

The instrument column.

Canonical target

causalis.data_contracts.causaldata_instrumental.CausalDataInstrumental.instrument

Sections

Returns
Link to this symbol
method
causalis.data_contracts.causaldata_instrumental.CausalDataInstrumental.get_df

get_df

Get a DataFrame with specified columns including instrument.

Parameters

columnsList[str], optional

Specific column names to include.

include_treatmentbool, default True

Whether to include the treatment column.

include_outcomebool, default True

Whether to include the outcome column.

include_confoundersbool, default True

Whether to include confounder columns.

include_user_idbool, default False

Whether to include the user_id column.

include_instrumentbool, default False

Whether to include the instrument column.

Returns

pd.DataFrame

A copy of the internal DataFrame with selected columns.

Raises

ValueError

If any specified columns do not exist.

Canonical target

causalis.data_contracts.causaldata_instrumental.CausalDataInstrumental.get_df

Sections

ParametersReturnsRaises
Link to this symbol
method
causalis.data_contracts.causaldata_instrumental.CausalDataInstrumental.__repr__

__repr__

Canonical target

causalis.data_contracts.causaldata_instrumental.CausalDataInstrumental.__repr__

Link to this symbol