Replace validate_epiparameter()
with assert_epiparameter()
#366
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.
Breaking change
This PR addresses #361 by replacing the
validate_epiparameter()
function withassert_epiparameter()
, and adds thetest_epiparameter()
function. Theassert_epiparameter()
andtest_epiparameter()
have the same logic but differ in their output and side-effects.assert_*()
errors when the object is not an<epiparameter>
whereastest_*()
will returnFALSE
. This follows the {checkmate} naming convention and is a development following #364.Functions that previously called
validate_epiparameter()
now callassert_epiparameter()
.A bullet point is also added to the
design_principles.Rmd
vignette to give context to the development and naming of the class helper functions and methods.