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

Rename truncation() to truncate_linelist() #193

Merged
merged 2 commits into from
Feb 19, 2025
Merged

Conversation

joshwlambert
Copy link
Member

This PR addresses #186 by renaming the truncation() function to truncate_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 from sim_linelist() (or the first list element of sim_outbreak()), and 2) to avoid namespace conflicts with other functions, for example the truncate() function in base R and the messy() function from the {messy} package. (On the former naming conflict, truncate() and therefore truncate_linelist() starting with a verb is preferable to truncation()).

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.

@joshwlambert
Copy link
Member Author

The lint-changed-files workflow is failing since the release of {lintr} v3.2.0 last week. I will fix in a separate PR as the changes required are orthogonal to the changes in this PR.

@joshwlambert joshwlambert merged commit 1c8a9cd into main Feb 19, 2025
8 of 9 checks passed
@joshwlambert joshwlambert deleted the rename-truncate branch February 19, 2025 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant