Rename truncation()
to truncate_linelist()
#193
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.
This PR addresses #186 by renaming the
truncation()
function totruncate_linelist()
.This follows the point added to the
design-principles.Rmd
vignette in #187 that post-processing function in {simulist} should follow the naming convention*_linelist()
, to 1) make it clear they are operating on a line list<data.frame>
output fromsim_linelist()
(or the first list element ofsim_outbreak()
), and 2) to avoid namespace conflicts with other functions, for example thetruncate()
function in base R and themessy()
function from the {messy} package. (On the former naming conflict,truncate()
and thereforetruncate_linelist()
starting with a verb is preferable totruncation()
).This PR also tries to correct the hyphenation of "right-truncation" when used as an adjective and "right truncation" when used as a noun, as pointed out by @sbfnk in #179.