Skip to content

Commit

Permalink
Update main.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
KennyZhang-17 committed Dec 2, 2024
1 parent 237d5cc commit a45d7f0
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions sensemakr/docs/modules/main.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ Examples
>>> fitted_model = model.fit()
>>> # Runs sensemakr for sensitivity analysis
>>> sensitivity = smkr.Sensemakr(fitted_model, treatment = "directlyharmed", benchmark_covariates = "female", kd = [1, 2, 3])
>>> # Manual bounds example:
>>> sensitivity_manual = smkr.Sensemakr(model = fitted_model, treatment = "directlyharmed", r2dz_x = [0.1, 0.2], r2yz_dx= [0.2, 0.3], bound_label= ["bound 1", "bound 2"])
>>> # List of Lists example:
>>> sensitivity_lists = smkr.Sensemakr(model = fitted_model, treatment = "directlyharmed", benchmark_covariates = [['female'], ['pastvoted','female']])
>>> # Dictionary Example:
>>> sensitivity_dict = smkr.Sensemakr(model = fitted_model, treatment = "directlyharmed", benchmark_covariates = {'Fem':['female'],"FemPast":["female","pastvoted"]})
>>> # Description of results
>>> sensitivity.summary() # doctest: +SKIP

Expand Down

0 comments on commit a45d7f0

Please sign in to comment.