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.

Sign up for GitHub

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

Jump to bottom

Add Key features and Complimentary R packages sections to README #134

Merged
merged 3 commits into from
May 31, 2024
Merged

Add Key features and Complimentary R packages sections to README #134

merged 3 commits into from
May 31, 2024

Conversation

joshwlambert
Copy link
Member

This PR adds two sections to the package README.

  1. A Key features section that lists the main features offered by {simulist} for simulating line list and contact tracing data
  2. A Complimentary R packages section that lists the R packages where {simulist} is designed to be interoperable and is documented in the {simulist} documentation how to use the R packages together. For example {incidence2} and {epicontacts} are used in the vis-linelist.Rmd vignette, and {epiparameter} is used to parameterise the simulation.

@joshwlambert joshwlambert added the documentation Improvements or additions to documentation label May 31, 2024
@joshwlambert joshwlambert merged commit 08b2822 into main May 31, 2024
2 checks passed
@joshwlambert joshwlambert deleted the readme-features branch May 31, 2024 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@joshwlambert @actions-user