Quickstart fixes and general improvement

[drbenvincent]

• Fixes the broken Quickstart example reported in After installing CausalPy via pip, /data folder isn't deployed as part of the package #81 / Improve the pypi distributed code. Include the data + improve data loading #84.
• Changed importing of libraries which has enabled a slightly cleaner API
• Added a load_data function.
• Data (*.csv files) are now included in the package distribution.
• Also re-ran all the notebooks so the docs will auto update to reflect the new API.
• This has been tested with a local import from test.pypi.org, so I'm pretty confident it should work.
• Remaining known issue: Plots don't appear when running from ipython session #86

New Quickstart

No need to import pandas and pathlib now.

import causalpy as cp


# Import and process data
df = (
    cp.load_data("drinking")
    .rename(columns={"agecell": "age"})
    .assign(treated=lambda df_: df_.age > 21)
    .dropna(axis=0)
    )

# Run the analysis
result = cp.pymc_experiments.RegressionDiscontinuity(
    df,
    formula="all ~ 1 + age + treated",
    running_variable_name="age",
    prediction_model=cp.pymc_models.LinearRegression(),
    treatment_threshold=21,
    )

# Visualize outputs
fig, ax = result.plot();

# Get a results summary
result.summary()

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB