Add defaults to all exported function arguments #149
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 #120 and #145 (#146 has also been resolved in this PR, see comment below) by adding defaults to the arguments in
sim_linelist()
,sim_contacts()
andsim_outbreaks()
that were previously missing.This now enables these functions to be run without the user specifying any arguments, e.g.
linelist <- sim_linelist()
.The documentation for the arguments has also be improved as suggested in #145. In combination with the argument documentation, the README, vignettes and function examples have also been added to. These now cover using a simple function call without specifying any arguments (in the README and function examples), using predefined and anonymous functions (in the
simulist.Rmd
vignette).Regression unit tests have been added for the new simpler function calls for
sim_*()
functions.Documentation for several internal function is also updated (mainly because of inheriting documentation from
sim_*()
functions).