CDCgov / multisignal-epi-inference

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

47 thl2 first pass on documentation #96

Closed cshelley closed 2 months ago

cshelley commented 2 months ago

Completed first-pass documention on getting_started.qmd. Still think it would be good to at least point users toward a description of renewal models in general and ours specifically.

gvegayon commented 2 months ago

I'll take a look at the conflicts.

codecov[bot] commented 2 months ago

Codecov Report

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

Project coverage is 91.48%. Comparing base (59f5625) to head (e457887).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #96 +/- ## ======================================= Coverage 91.48% 91.48% ======================================= Files 33 33 Lines 634 634 ======================================= Hits 580 580 Misses 54 54 ``` | [Flag](https://app.codecov.io/gh/CDCgov/multisignal-epi-inference/pull/96/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/96/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CDCgov) | `91.48% <ø> (ø)` | | 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.