CDCgov / multisignal-epi-inference

Python package for statistical inference and forecast of epi models using multiple signals
https://cdcgov.github.io/multisignal-epi-inference/
9 stars 1 forks source link

Add Developer Documentation #224

Open damonbayer opened 3 days ago

damonbayer commented 3 days ago

First draft of developer documentation. Highly encourage comments and PR's against this branch from all of @CDCgov/multisignal-epi-inference-devs.

In particular, I would like for someone (@gvegayon?) to make sure this is added to the website (and document how to do that in the developer documentation).

Closes https://github.com/CDCgov/multisignal-epi-inference/issues/7.

codecov[bot] commented 3 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.47%. Comparing base (ae4424f) to head (8ff76a3). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #224 +/- ## ======================================= Coverage 92.47% 92.47% ======================================= Files 40 40 Lines 877 877 ======================================= Hits 811 811 Misses 66 66 ``` | [Flag](https://app.codecov.io/gh/CDCgov/multisignal-epi-inference/pull/224/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CDCgov) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/CDCgov/multisignal-epi-inference/pull/224/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CDCgov) | `92.47% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CDCgov#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.