epiverse-trace / epichains

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
6 stars 2 forks source link

Revise summary.epichains_tree to return <epichains_summary> #210

Closed jamesmbaazam closed 8 months ago

jamesmbaazam commented 8 months ago

A feature.

summary.epichains_tree method calculates the max generation, number of unique infectors from the <epichains_tree> object.

The summary.epichains_tree now returns epichains_summary with the same results as simulate_summary()

No, since this package is not released.

This PR closes #119.

codecov-commenter commented 8 months ago

Codecov Report

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

Project coverage is 98.77%. Comparing base (918ee12) to head (fe32c96). Report is 40 commits behind head on main.

:exclamation: Current head fe32c96 differs from pull request most recent head 9e349f0. Consider uploading reports for the commit 9e349f0 to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #210 +/- ## ========================================== - Coverage 98.90% 98.77% -0.14% ========================================== Files 8 8 Lines 550 573 +23 ========================================== + Hits 544 566 +22 - Misses 6 7 +1 ```

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

jamesmbaazam commented 8 months ago

Super! Just one comment: would it make sense to add a setequal test (as in the example)? That way we can make sure the two implementations don't diverge.

Thanks, that makes sense. I've made the change here 15f10d2180ae80467f0d8c2c4521629d8bf71da7.