Parameter and output documentation. #299
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
…on't think it needs to be multiplied by psi. When these values are drawn in lines 135-140 of biting_process.R they get multiplied by psi in line 144. That means we're effectively multiplying these values by psi^2. I think we can correct this by adjusting the calculation thusly. The two tests at the end would then need adjusting (one way or another) to reflect this change - which could use improving.
… to rendering tests to reflect additional outputs.
…n from another PR.
…od to tidy up. First, n_severe isn't a prevalence output (model.R). I've reorganised the parameter documentation list into an order I think is a bit more intuitive, with consistency between code and documentation.
RJSheppard
force-pushed
the
parameter_documentation_ordering
branch
from
bcbafc2 to
6ec5e3d
Compare
giovannic
requested changes
May 8, 2024
R/parameters.R
Outdated
| #' please set vaccine strategies with the convenience functions in | ||
| #' `pev_parameters.R:set_pev_epi` | ||
| #' `pev_parameters.R:set_mass_pev` | ||
| #' `pev_parameters.R::set_pev_epi` |
There was a problem hiding this comment.
Is this a thing?
If we're going to make these references more formal shouldn't we use Roxygen syntax?
Suggested change
| #' `pev_parameters.R::set_pev_epi` | |
| #' \code{\link{set_pev_epi}} |
There was a problem hiding this comment.
Good shout! I'm not super familiar with the syntax, so thanks for pointing this out. I've now changed all the references to other functions to links to the help pages.
pwinskill
approved these changes
May 10, 2024
There was a problem hiding this comment.
Thanks Richard
Looks like a few of the new links in the docs are upsetting the checks:
❯ checking Rd cross-references ... WARNING
Missing link or links in Rd file 'get_parameters.Rd':
'set_betnets' 'set_epi_outputs'
See section 'Cross-references' in the 'Writing R Extensions' manual.
Otherwise looks great
|
I've corrected the set_bednets function spelling, but I think I'll leave the epi outputs in, then merge this one after we merge that branch. |
calculate_eir function correction
dqrng just released a new version, which means we can stop relying on the mrc-ide r-universe as an additional repository.
Depend on dqrng from CRAN again.
… to rendering tests to reflect additional outputs.
…n from another PR.
…de/malariasimulation into lm_pcr_prevalence_explicit
…od to tidy up. First, n_severe isn't a prevalence output (model.R). I've reorganised the parameter documentation list into an order I think is a bit more intuitive, with consistency between code and documentation.
…parameter help page.
…/mrc-ide/malariasimulation into parameter_documentation_ordering
This PR labels detection outputs explicitly as pcr or lm detectable.
giovannic
approved these changes
May 23, 2024
…od to tidy up. First, n_severe isn't a prevalence output (model.R). I've reorganised the parameter documentation list into an order I think is a bit more intuitive, with consistency between code and documentation.
…parameter help page.
…/mrc-ide/malariasimulation into parameter_documentation_ordering
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.
There are a few parameter documentation things I think it would be good to tidy up. First, n_severe isn't a prevalence output (model.R). I've then reorganised the parameter documentation list into an order I think is a bit more intuitive, with consistency between code and documentation. Nothing has fundamentally changed, just the order, and some small text things to improve clarity, e.g., "probability of detection by light-microscopy when asymptomatic".