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

Dcm ngm primer #53

Merged
merged 29 commits into from
Jan 21, 2025
Merged

Dcm ngm primer #53

merged 29 commits into from
Jan 21, 2025

Conversation

dinacmistry
Copy link
Contributor

No description provided.

@dinacmistry dinacmistry marked this pull request as draft December 13, 2024 20:07
@dinacmistry
Copy link
Contributor Author

No where even close to done, just making it a draft right now so I can use PR tools.

@dinacmistry
Copy link
Contributor Author

Also, there will be so many commits on this as I figure my way through how I want to write about this in a way that's hopefully clear and useful to others. I'll plan to squash as many commits as I think reasonable closer to when a draft is complete.

@dinacmistry dinacmistry self-assigned this Dec 13, 2024
@dinacmistry dinacmistry linked an issue Dec 13, 2024 that may be closed by this pull request
@dinacmistry dinacmistry marked this pull request as ready for review January 2, 2025 16:44
changing primer name and topic shift

adding relationship to branching processes

changing language, will squash later
language change

language change

v not m matrix

to and from direction

reorg material

more careful language
commenting out some lines, new text
clearning up use as model section

other DFE

cleaning up rescaling explanation

add context about spectral radius

commenting out different population sizes part for now

unfinished sections named
@dinacmistry dinacmistry marked this pull request as draft January 2, 2025 17:04
… definition

removing unneeded commented lines

removing separate in this repo section
@dinacmistry dinacmistry marked this pull request as ready for review January 3, 2025 20:30
@dinacmistry
Copy link
Contributor Author

This feels like a fairly comprehensive review of NGMs.

Fwiw, the formulation in the approach doc, $R_{ij} = \frac{\beta_{ij}S_i}{\gamma N}$ is not accurate though it functionally still works. If we're going to be formal about definitions, we should replace $S_i$ with $N_i$. This is because we linearize the system around that DFE, so that $S_i \approx N_i$ and then we can define the NGM. I think it's an important difference since $N_i$ is a constant, while $S_i$ isn't.

docs/primer.md Outdated Show resolved Hide resolved
@dinacmistry dinacmistry requested a review from jrcpulliam January 6, 2025 15:38
docs/primer.md Outdated Show resolved Hide resolved
docs/primer.md Outdated Show resolved Hide resolved
docs/primer.md Outdated Show resolved Hide resolved
@dinacmistry dinacmistry mentioned this pull request Jan 21, 2025
@dinacmistry
Copy link
Contributor Author

This is helpful! There are a number of minor math formatting issues in Github as already noted.

I like the list of assumptions - can we make it more of a compact list rather than subsections?

Do you think it could be helpful to write some sort of glossary explaining the main terms used here (spectral radius, eigenvalues, eigenvectors, transition matrix, transmission matrix, DFE) and how they relate to disease models?

I think if the audience is Andy and me before this project, I could have used a more concrete example showing an example NGM itself, the way you get R0 and infection distribution (which means we need a bit about the eigenvector of the NGM) and the way you think about adding in vaccination by factoring rows by the proportion susceptible remaining. The example now is a bit confusing, since it references K&R but only in that it arrives at the NGM of beta/gamma * N_i / N. I guess the helpful thing from K&R for me was validating that we understood what exactly was the NGM, and corresponding R0 and infection distribution. Without numbers, I think the example now still could have been a bit mystifying for me a month ago.

Thanks @paigemiller! Made a few changes to address yourfeedback:

  • made the conditions and limitations section into a bulleted list
  • new issue for glossary since I think this is out of scope for a first draft of the primer
  • new issue for explicit example with vaccination, which is probably going to be just cannibalizing what's in the approach doc

@swo
Copy link
Contributor

swo commented Jan 21, 2025

@dinacmistry I think this is mature enough that we should just merge it?

We can revisit in #91 , to see how this will work with other docs

@dinacmistry dinacmistry requested a review from swo January 21, 2025 17:52
@dinacmistry
Copy link
Contributor Author

@dinacmistry I think this is mature enough that we should just merge it?

We can revisit in #91 , to see how this will work with other docs

Re-requested your review - need approval for the merge. Thanks!

@dinacmistry
Copy link
Contributor Author

Just a heads up: there were a lot of great points brought up in this PR. Some were out of scope so I made issues for them either in this repo or in the recipes repo if it required more math details/explanations. I think we should merge this now.

@paigemiller paigemiller self-requested a review January 21, 2025 19:00
docs/primer.md Outdated Show resolved Hide resolved
docs/primer.md Outdated Show resolved Hide resolved
docs/primer.md Outdated Show resolved Hide resolved
Copy link
Contributor

@paigemiller paigemiller left a comment

Choose a reason for hiding this comment

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

This looks good to me! just suggested a few small edits to improve readability

@dinacmistry
Copy link
Contributor Author

This looks good to me! just suggested a few small edits to improve readability

Got it, will make those edits and then merge. Thanks Paige!

@dinacmistry dinacmistry merged commit d0fd152 into main Jan 21, 2025
2 checks passed
@dinacmistry dinacmistry deleted the dcm-ngm-primer branch January 21, 2025 20:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add NGM primer
5 participants