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

Replace validate_epiparameter() with assert_epiparameter() #366

Merged
merged 6 commits into from
Aug 13, 2024
Merged

Conversation

joshwlambert
Copy link
Member

@joshwlambert joshwlambert commented Aug 13, 2024

Breaking change

This PR addresses #361 by replacing the validate_epiparameter() function with assert_epiparameter(), and adds the test_epiparameter() function. The assert_epiparameter() and test_epiparameter() have the same logic but differ in their output and side-effects. assert_*() errors when the object is not an <epiparameter> whereas test_*() will return FALSE. This follows the {checkmate} naming convention and is a development following #364.

Functions that previously called validate_epiparameter() now call assert_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.

@joshwlambert
Copy link
Member Author

The test-coverage GHA is failing, but the tests pass on the R-CMD-check across all OSs, so I'll merge this PR and see if the tests continue to fail.

@joshwlambert joshwlambert merged commit 6a6c869 into main Aug 13, 2024
7 of 8 checks passed
@joshwlambert joshwlambert deleted the assert branch August 13, 2024 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant