Skip to main content

DidCs

Struct DidCs 

Source
pub struct DidCs { /* private fields */ }
Expand description

Difference-in-differences with repeated cross-sections: the data need a 0/1 time indicator (DmlData::with_time_indicator). ml_g learns E[Y | D = d, T = t, X] separately in each of the four group × period cells, ml_m the propensity P(D = 1 | X) (observational score only).

Implementations§

Source§

impl DidCs

Source

pub fn new( ml_g: impl Regressor + 'static, ml_m: impl Classifier + 'static, ) -> Self

Observational design (doubly robust score).

Source

pub fn experimental(ml_g: impl Regressor + 'static) -> Self

Randomised design: only the outcome model is needed.

Source

pub fn from_boxed( ml_g: Box<dyn Regressor>, ml_m: Option<Box<dyn Classifier>>, ) -> Self

Source

pub fn score(self, score: DidScore) -> Self

Observational (default) or experimental score.

Source

pub fn in_sample_normalization(self, normalize: bool) -> Self

Normalise the weights by their sample means (default true, as DoubleML); false uses the plug-in probabilities.

Source

pub fn clipping_threshold(self, t: f64) -> Self

Propensities are clipped to [t, 1 − t] (default 0.01).

Source

pub fn calibration(self, calibration: Calibration) -> Self

Calibrate the propensity scores before clipping (default: none), as DoubleML’s ps_processor_config.

Source

pub fn n_folds(self, n_folds: usize) -> Self

Number of cross-fitting folds (default 5).

Source

pub fn n_rep(self, n_rep: usize) -> Self

Number of independent sample splits (default 1). Estimates are aggregated across repetitions by the median, as in DoubleML.

Source

pub fn seed(self, seed: u64) -> Self

Seed for the sample splits (default 0).

Source

pub fn fit(&self, data: &DmlData) -> Result<DmlFit>

Draw seeded sample splits and fit. With clustered data (DmlData::with_clusters) whole clusters are assigned to folds and standard errors are cluster-robust.

Source

pub fn fit_with_cluster_folds( &self, data: &DmlData, splits: &[Vec<ClusterFold>], ) -> Result<DmlFit>

Fit clustered data with explicit cluster folds, one Vec<ClusterFold> per repetition.

Source

pub fn sensitivity_benchmark( &self, data: &DmlData, long: &DmlFit, benchmarking_set: &[usize], ) -> Result<SensitivityBenchmark>

Sensitivity benchmark for the covariate columns benchmarking_set: refits this model without them (with the same sample splitting, so long must come from fit with the current settings) and compares it with long.

Source

pub fn fit_with_folds( &self, data: &DmlData, splits: &[Vec<Fold>], ) -> Result<DmlFit>

Fit with caller-supplied splits, one Vec<Fold> per repetition (e.g. to reproduce another implementation exactly).

Source

pub fn nuisance_regressor( self, name: &str, learner: impl Regressor + 'static, ) -> Self

Use learner for the regression nuisance name (DoubleML’s name, e.g. "ml_g1") instead of the model’s default learner for it.

Source

pub fn nuisance_regressor_boxed( self, name: &str, learner: Box<dyn Regressor>, ) -> Self

As nuisance_regressor, boxed.

Source

pub fn nuisance_classifier( self, name: &str, learner: impl Classifier + 'static, ) -> Self

Use learner for the classification nuisance name instead of the model’s default learner for it.

Source

pub fn nuisance_classifier_boxed( self, name: &str, learner: Box<dyn Classifier>, ) -> Self

Trait Implementations§

Source§

impl LinearScoreModel for DidCs

Source§

fn name(&self) -> String

Label for summaries, e.g. "PLR (partialling out)".
Source§

fn validate(&self, data: &DmlData) -> Result<()>

Reject data the model cannot handle (called once before fitting).
Source§

fn estimate_score( &self, input: &ScoreInput<'_>, folds: &[Fold], ) -> Result<ScoreEstimate>

Cross-fit the nuisances on folds and return the score elements.
Source§

fn strata(&self, _data: &DmlData) -> Option<Vec<usize>>

Strata for the default sample splits (e.g. treatment levels), so each fold holds about the same share of every stratum. None (the default) draws plain K-fold splits.

Auto Trait Implementations§

§

impl !RefUnwindSafe for DidCs

§

impl !UnwindSafe for DidCs

§

impl Freeze for DidCs

§

impl Send for DidCs

§

impl Sync for DidCs

§

impl Unpin for DidCs

§

impl UnsafeUnpin for DidCs

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V