Added check for undeveloped antimalarial resistance features (SPC/LPF… #282
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
…/LCF/RDP). Included test to ensure check works and amended documentation in get_parameters() to warn users features in development.
pwinskill
approved these changes
Feb 15, 2024
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.
Following the suggestion in the antimalarial_resistance/etf pull request, I have added a check in the
set_antimalarial_resistance()function to error when users attempt to give non-zero values to parameters relating to undeveloped features.I have also added a test to the test-antimalarial-resistance.R file to ensure the check works as anticipated.
The documentation entries for the parameters in the
get_parameters()(parameters.R) documentation have been modified to warn users that the parameters represent features under development.I stopped short of adding a note in the vignette, but can add this if it is thought to be a good idea!