Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rate multipliers and IgG count #260

Merged
merged 77 commits into from
Feb 26, 2024
Merged

Rate multipliers and IgG count #260

merged 77 commits into from
Feb 26, 2024

Conversation

mghosh00
Copy link
Contributor

@mghosh00 mghosh00 commented Feb 14, 2024

Summary

We have added the RateMultiplier (so that individuals with waning immunity have different transition probabilities between statuses), implemented these into a waning transition matrix, and added the IgGFOIMultiplier (so that the force of infection is lessened for waning individuals) classes. We have also sourced parameters for the IgGFOIMultiplier class from this paper by Lumley et al. as explained in the updated Parameters section of the wiki.

Further work

Some parameters for RateMultiplier have been sourced, but we still need to find more to complete all transitions between states.

Checklist

  • All new functions have docstrings in the correct style

  • I've verified the complete docs build locally without errors

  • I've maintained 100% coverage (please mention any 'no cover' annotations explicitly)

  • I've unit-tested all new methods directly

  • Breaking change (fix or feature that would cause existing functionality to change)

  • I have read the CONTRIBUTING document.

  • My code follows the code style of this project.

  • I have updated the wiki with new parameters/model functionality

Closing issues

Closes #254 and #256

Copy link
Contributor

@KCGallagher KCGallagher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, a few small suggestions here! mportantly, might you be able to run the case study on a different country (as NZ) instead of Gilraltar? The gibraltar results were generated as a comparison to CovidSim for our original paper (publication pending) and covidsim doesn't have waning immunity!

pyEpiabm/pyEpiabm/sweep/host_progression_sweep.py Outdated Show resolved Hide resolved
pyEpiabm/pyEpiabm/sweep/transition_matrices.py Outdated Show resolved Hide resolved
pyEpiabm/pyEpiabm/sweep/transition_matrices.py Outdated Show resolved Hide resolved
Matrix in the form of a dataframe

"""
waning_matrix =\
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This all seems quite complicated - can you document the maths of this process in the wiki, and link it here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wiki is in progress!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@abbie-evans Can you add this link to this docstring so users can find it easily?

pyEpiabm/pyEpiabm/utility/igg_foi_multiplier.py Outdated Show resolved Hide resolved
pyEpiabm/pyEpiabm/utility/igg_foi_multiplier.py Outdated Show resolved Hide resolved
pyEpiabm/pyEpiabm/utility/rate_multiplier.py Outdated Show resolved Hide resolved
Copy link
Contributor

@KCGallagher KCGallagher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pre-approving provided you look at the two small comments, great work otherwise!

Matrix in the form of a dataframe

"""
waning_matrix =\
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@abbie-evans Can you add this link to this docstring so users can find it easily?

pyEpiabm/pyEpiabm/sweep/host_progression_sweep.py Outdated Show resolved Hide resolved
@abbie-evans abbie-evans merged commit 7f4cdc0 into main Feb 26, 2024
15 checks passed
@KCGallagher
Copy link
Contributor

KCGallagher commented Aug 4, 2024

@abbie-evans @mghosh00 Can you revisit this - the PR description said that you have updated the wiki to include all new parameters, but a quick search of the plain text shows this is not complete. All parameters should be documented on the wiki, with sources and an explanation of what each parameter is.

Edit: For structured parameters (such as nested lists) you should also explain the structure of the data object.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request python Changes related to pyEpiabm backend
Projects
None yet
Development

Successfully merging this pull request may close these issues.

State transition for waning immunity Change Transition Probabilities for People with Waning Immunity
4 participants