-
Notifications
You must be signed in to change notification settings - Fork 0
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 defaults to all exported function arguments #149
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @joshwlambert 🙏
Given that I am wrapping up before my summer holidays, I did not dive in too deep. I did request this addition so I tested the end result - and it is of great help for demo purposes to be able to run sim_linelist()
and sim_contact()
and get results.
Thank you again for picking up this suggestion, I appreciate it!
This PR now also addresses #146 by not warning users if the The |
…nset_to_hosp and onset_to_death are given
24d7252
to
537528f
Compare
Co-authored-by: Sebastian Funk <sebastian.funk@lshtm.ac.uk>
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).