Skip to content
Submodule
causalis.dgp.causaldata.preperiod

preperiod

Submodule causalis.dgp.causaldata.preperiod with no child pages and 14 documented members.

Classes

Jump directly into the documented classes for this page.

1 items

Functions

Jump directly into the documented functions for this page.

3 items

Data

Jump directly into the documented data for this page.

2 items
data
causalis.dgp.causaldata.preperiod.CorrMethod

CorrMethod

Value: None

None

Canonical target

causalis.dgp.causaldata.preperiod.CorrMethod

Link to this symbol
data
causalis.dgp.causaldata.preperiod.Transform

Transform

Value: None

None

Canonical target

causalis.dgp.causaldata.preperiod.Transform

Link to this symbol
function
causalis.dgp.causaldata.preperiod.corr_on_scale

corr_on_scale

Canonical target

causalis.dgp.causaldata.preperiod.corr_on_scale

Link to this symbol
class
causalis.dgp.causaldata.preperiod.PreCorrSpec

PreCorrSpec

Canonical target

causalis.dgp.causaldata.preperiod.PreCorrSpec

Link to this symbol
attribute
causalis.dgp.causaldata.preperiod.PreCorrSpec.target_corr

target_corr

Value: 0.7

0.7

Canonical target

causalis.dgp.causaldata.preperiod.PreCorrSpec.target_corr

Link to this symbol
attribute
causalis.dgp.causaldata.preperiod.PreCorrSpec.transform

transform

Value: 'log1p'

‘log1p’

Canonical target

causalis.dgp.causaldata.preperiod.PreCorrSpec.transform

Link to this symbol
attribute
causalis.dgp.causaldata.preperiod.PreCorrSpec.winsor_q

winsor_q

Value: 0.999

0.999

Canonical target

causalis.dgp.causaldata.preperiod.PreCorrSpec.winsor_q

Link to this symbol
attribute
causalis.dgp.causaldata.preperiod.PreCorrSpec.method

method

Value: 'pearson'

‘pearson’

Canonical target

causalis.dgp.causaldata.preperiod.PreCorrSpec.method

Link to this symbol
attribute
causalis.dgp.causaldata.preperiod.PreCorrSpec.sigma_lo

sigma_lo

Value: 0.0

0.0

Canonical target

causalis.dgp.causaldata.preperiod.PreCorrSpec.sigma_lo

Link to this symbol
attribute
causalis.dgp.causaldata.preperiod.PreCorrSpec.sigma_hi

sigma_hi

Value: 50.0

50.0

Canonical target

causalis.dgp.causaldata.preperiod.PreCorrSpec.sigma_hi

Link to this symbol
attribute
causalis.dgp.causaldata.preperiod.PreCorrSpec.sigma_tol

sigma_tol

Value: 0.001

0.001

Canonical target

causalis.dgp.causaldata.preperiod.PreCorrSpec.sigma_tol

Link to this symbol
attribute
causalis.dgp.causaldata.preperiod.PreCorrSpec.max_iter

max_iter

Value: 40

40

Canonical target

causalis.dgp.causaldata.preperiod.PreCorrSpec.max_iter

Link to this symbol
function
causalis.dgp.causaldata.preperiod.calibrate_sigma_for_target_corr

calibrate_sigma_for_target_corr

Find sigma such that Corr(T(y_pre_base + sigma*eps), T(y_post)) ~ target_corr. Returns (sigma, achieved_corr).

Canonical target

causalis.dgp.causaldata.preperiod.calibrate_sigma_for_target_corr

Link to this symbol
function
causalis.dgp.causaldata.preperiod.add_preperiod_covariate

add_preperiod_covariate

Standardized utility to add a calibrated pre-period covariate to a DataFrame.

Parameters

dfpd.DataFrame

The dataset.

y_colstr

Name of the outcome column.

d_colstr

Name of the treatment column.

pre_namestr

Name of the new pre-period covariate column.

base_buildercallable

Function df -> y_pre_base (np.ndarray) providing the shared signal.

specPreCorrSpec

Specification for target correlation and scale.

rngnp.random.Generator

Random number generator.

masknp.ndarray, optional

Boolean mask of rows to use for calibration (e.g. control group). If None, use control group (d == 0).

Canonical target

causalis.dgp.causaldata.preperiod.add_preperiod_covariate

Sections

Parameters
Link to this symbol