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

Add messy_linelist() function #187

Open
wants to merge 35 commits into
base: main
Choose a base branch
from
Open

Add messy_linelist() function #187

wants to merge 35 commits into from

Conversation

joshwlambert
Copy link
Member

This PR adds the messy_linelist() function to the package (closes #183). This function takes the output of sim_linelist() or the first list element of the output of sim_outbreak() and converts the clean line list data into messy line list data.

A new internal function, .spelling_mistake() is added which is called by messy_linelist().

Unit tests are added for the messy_linelist() function.

The {english} package is added as an Imported dependency in the DESCRIPTION. This is called by messy_linelist() when int_as_word = TRUE (which it is by default) to convert integers into words.

The README is updated to include:

  • {cleanepi} in the Complimentary R packages section
  • {messy} in the Related projects section

The design-principles.Rmd vignette is updated, adding a bullet point on the function naming convention for exported post-processing functions (renaming of truncation() required, #186), and adding {english} to the list of hard package dependencies.

@joshwlambert joshwlambert added the enhancement New feature or request label Feb 10, 2025
Copy link

This pull request:

  • Adds 1 new dependencies (direct and indirect)
  • Adds 1 new system dependencies
  • Removes 0 existing dependencies (direct and indirect)
  • Removes 0 existing system dependencies

Reach out on slack (#code-review or #help channels) to double check if there are base R alternatives to the new dependencies.

(Note that results may be inaccurate if you branched from an outdated version of the target branch.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feedback on the messy Function
2 participants