Rename <epidist>
with <epiparameter>
#360
Merged
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 changes
This PR addresses #325 by renaming the main class in {epiparameter} from
<epidist>
to<epiparameter>
. This is due to potential conflict or confusion with the {epidist} R package.Function names that previously used
epidist
now useepiparameter
(for exceptions see below). These include:epiparameter_db()
,epiparameter()
,as_epiparameter()
, etc. The other class used in {epiparameter},<multi_epidist>
has also been renamed to<multi_epiparameter>
.Naming the class after the package also follows the idiomatic convention of other R packages, e.g. {incidence} and
<incidence>
, {epicontacts} and<epicontacts>
.The other change made in this PR is to shorten the names of the
create_*()
and.clean_*()
functions by removingepidist
from the name. If there is a conflict with other functions with the same name from another package then the functions can be explicitly namespaced (epiparameter::create_uncertainty()
).