Skip to content

Commit 1451729

Browse files
committed
Updating Change-log for all v0.9.0 additions
1 parent 07f46de commit 1451729

File tree

1 file changed

+35
-11
lines changed

1 file changed

+35
-11
lines changed

CHANGELOG.md

+35-11
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,23 @@ include `SingleCrossfitAIPTW`, `DoubleCrossfitAIPTW`, `SingleCrossfitTMLE`, and
99
functionality is limited to treatment and outcome nuisance models only (i.e. no model for missing data). These
1010
estimators also do not accept weighted data (since most of `sklearn` does not support weights)
1111

12-
`TimeFixedGFormula` is being deprecated in favor of two estimators with different labels. This will more clearly
13-
delineate ATE versus stochastic effects. The replacement estimators are ...
12+
Super-learner functionality has been added via `SuperLearner`. Additions also include emprical mean (`EmpiricalMeanSL`),
13+
generalized linear model (`GLMSL`), and step-wise backward/forward selection via AIC (`StepwiseSL`). These new
14+
estimators are wrappers that are compatible with `SuperLearner` and mimic some of the R superlearner functionality.
15+
16+
Directed Acyclic Graphs have been added via `DirectedAcyclicGraph`. These analyze the graph for sufficient adjustment
17+
sets, and can be used to display the graph. These rely on an optional NetworkX dependency.
18+
19+
`AIPTW` now supports the `custom_model` optional argument for user-input models. This is the same as `TMLE` now.
20+
21+
`zipper_plot` function for creating zipper plots has been added.
22+
23+
Housekeeping: `bound` has been updated to new procedure, updated how `print_results` displays to be uniform, created
24+
function to check missingness of input data in causal estimators, added warning regarding ATT and ATU variance for
25+
IPTW, and added back observation IDs for `MonteCarloGFormula`
26+
27+
Future plans: `TimeFixedGFormula` will be deprecated in favor of two estimators with different labels. This will more
28+
clearly delineate ATE versus stochastic effects. The replacement estimators are to be added
1429

1530
### v0.8.2
1631
`IPSW` and `AIPSW` now natively support adjusting for confounding. Both now have the `treatment_model()` function,
@@ -268,9 +283,9 @@ specified
268283

269284
``TMLE`` now allows estimation of risk ratios and odds ratios. Estimation procedure is based on ``tmle.R``
270285

271-
``TMLE`` variance formula has been modified to match ``tmle.R`` rather than other resources. This is beneficial for future
272-
implementation of missing data adjustment. Also would allow for mediation analysis with TMLE (not a priority for me at
273-
this time).
286+
``TMLE`` variance formula has been modified to match ``tmle.R`` rather than other resources. This is beneficial for
287+
future implementation of missing data adjustment. Also would allow for mediation analysis with TMLE (not a priority
288+
for me at this time).
274289

275290
``TMLE`` now includes an option to place bounds on predicted probabilities using the ``bound`` option. Default is to use
276291
all predicted probabilities. Either symmetrical or asymmetrical truncation can be specified.
@@ -315,9 +330,14 @@ edition pg340.
315330
### v0.3.0
316331
**BIG CHANGES**:
317332

318-
To conform with PEP and for clarity, all association/effect measures on a pandas dataframe are now class statements. This makes them distinct from the summary data calculators. Additionally, it allows users to access any part of the results now, unlike the previous implementation. The SD can be pulled from the corresponds results dataframe. Please see the updated webiste for how to use the class statements.
333+
To conform with PEP and for clarity, all association/effect measures on a pandas dataframe are now class statements.
334+
This makes them distinct from the summary data calculators. Additionally, it allows users to access any part of the
335+
results now, unlike the previous implementation. The SD can be pulled from the corresponds results dataframe. Please
336+
see the updated webiste for how to use the class statements.
319337

320-
Name changes within the calculator branch. With the shift of the dataframe calculations to classes, now these functions are given more descriptive names. Additionally, all functions now return a list of the point estimate, SD, lower CL, upper CL. Please see the website for all the new function names
338+
Name changes within the calculator branch. With the shift of the dataframe calculations to classes, now these
339+
functions are given more descriptive names. Additionally, all functions now return a list of the point estimate, SD,
340+
lower CL, upper CL. Please see the website for all the new function names
321341

322342
Addition of Targeted Maximum Likelihood Estimator as zepid.causal.doublyrobust.TMLE
323343

@@ -384,18 +404,21 @@ Addition of IPW for Interference settings. No current timeline but hopefully bef
384404
Further conforming to PEP guidelines (my bad)
385405

386406
#### 0.1.6
387-
Removed histogram option from IPTW in favor of kernel density. Since histograms are easy to generate with matplotlib, just dropped the entire option.
407+
Removed histogram option from IPTW in favor of kernel density. Since histograms are easy to generate with matplotlib,
408+
just dropped the entire option.
388409

389410
Created causal branch. IPW functions moved inside this branch
390411

391-
Added depreciation warning to the IPW branch, since this will be removed in 0.2 in favor of the causal branch for organization of future implemented methods
412+
Added depreciation warning to the IPW branch, since this will be removed in 0.2 in favor of the causal branch for
413+
organization of future implemented methods
392414

393415
Added time-fixed g-formula
394416

395417
Added simple double-robust estimator (based on Funk et al 2011)
396418

397419
#### 0.1.5
398-
Fix to 0.1.4 and since PyPI does not allow reuse of library versions, I had to create new one. Fixes issue with ipcw_prep() that was a pandas error (tried to drop NoneType from columns)
420+
Fix to 0.1.4 and since PyPI does not allow reuse of library versions, I had to create new one. Fixes issue with
421+
ipcw_prep() that was a pandas error (tried to drop NoneType from columns)
399422

400423
#### 0.1.4
401424
Updates: Added dynamic risk plot
@@ -406,4 +429,5 @@ Fixes: Added user option to allow late entries for ipcw_prep()
406429
Updates: added ROC curve generator to graphics, allows user-specification of censoring indicator to ipcw,
407430

408431
#### 0.1.2
409-
Original release. Previous versions (0.1.0, 0.1.1) had errors I found when trying to install via PyPI. I forgot to include the `package` statement in `setup`
432+
Original release. Previous versions (0.1.0, 0.1.1) had errors I found when trying to install via PyPI. I forgot to
433+
include the `package` statement in `setup`

0 commit comments

Comments
 (0)