epiverse-trace / epichains

[Under active development] Methods for simulating and analysing the sizes and lengths of infectious disease transmission chains from branching process models
https://epiverse-trace.github.io/epichains/
Other
5 stars 2 forks source link

Rename `simulate_summary()` to `simulate_chain_stats()` for clarity #235

Closed jamesmbaazam closed 3 months ago

jamesmbaazam commented 5 months ago

This PR closes #118 by renaming simulate_summary() to simulate_chain_stats() to remove the confusion around its name and the role of the summary.epichains method.

codecov-commenter commented 5 months ago

Codecov Report

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

Project coverage is 98.80%. Comparing base (07f6087) to head (45574e3). Report is 27 commits behind head on main.

:exclamation: Current head 45574e3 differs from pull request most recent head 0bfded5. Consider uploading reports for the commit 0bfded5 to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #235 +/- ## ======================================= Coverage 98.80% 98.80% ======================================= Files 8 8 Lines 584 584 ======================================= Hits 577 577 Misses 7 7 ```

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

jamesmbaazam commented 3 months ago

I'm going to go ahead and merge this PR as it was just a renaming refactor. Any issues with it can be raised an issue.