Update description of the dt parameter. #288
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The dt parameter was described as "the delay to move from state Tr to Ph", but the Ph (prophylaxis) state does not exist in the model. Instead the dt parameter is used to transition from Tr to S, in `R/processes.R`. Looking at the commit history, there seems to have been a bit of back and forth around adding and removing the Tr and Ph states. The comment in question was introduced in #30, after the prophylaxis state had already been removed and even at the time the parameter was already used as the transition rate from Tr to S.
plietar
force-pushed
the
fix-parameter-comment
branch
from
4ad2a8b to
c395661
Compare
pwinskill
approved these changes
Apr 25, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The dt parameter was described as "the delay to move from state Tr to Ph", but the Ph (prophylaxis) state does not exist in the model. Instead the dt parameter is used to transition from Tr to S, in
R/processes.R.Looking at the commit history, there seems to have been a bit of back and forth around adding and removing the Tr and Ph states. The comment in question was introduced in #30, after the prophylaxis state had already been removed and even at the time the parameter was already used as the transition rate from Tr to S.