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 more details to README #38

Closed
joshwlambert opened this issue Jul 14, 2023 · 2 comments
Closed

Add more details to README #38

joshwlambert opened this issue Jul 14, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@joshwlambert
Copy link
Member

Add more detail to the opening section of the README. See {finalsize} and {epidemics} for examples.
@joshwlambert joshwlambert added the documentation Improvements or additions to documentation label Jul 14, 2023
@joshwlambert
Copy link
Member Author

Could add a sentence on citing where the methods came from, e.g. Lloyd-Smith et al. (2005). See {finalsize} for example.

@joshwlambert
Copy link
Member Author

Add text to Quick start section. The structure could follow:

  1. Explain which models are fit using {fitdistrplus}
  2. Explaining why {fitdistrplus} is being used
  3. Explain index_case_transmission and secondary_case_transmission
  4. Explain model output and relate to comments in code

joshwlambert added a commit that referenced this issue Jul 21, 2023
@joshwlambert
added method citations to readme, WIP #38
d7fe1de
joshwlambert added a commit that referenced this issue Jul 21, 2023
@joshwlambert
added information on nbinom fitting in readme, WIP #38
7ee42ce
joshwlambert added a commit that referenced this issue Jul 21, 2023
@joshwlambert
clarify nbinom fitting results in readme, WIP #38
f132625
joshwlambert added a commit that referenced this issue Jul 21, 2023
@joshwlambert
added information on probability of large epidemic in readme, closes #38
753a694
@joshwlambert joshwlambert mentioned this issue Jul 21, 2023
Merged
joshwlambert added a commit that referenced this issue Jul 21, 2023
@joshwlambert
added method citations to readme, WIP #38
b7bc361
joshwlambert added a commit that referenced this issue Jul 21, 2023
@joshwlambert
added information on nbinom fitting in readme, WIP #38
d52d2d9
joshwlambert added a commit that referenced this issue Jul 21, 2023
@joshwlambert
clarify nbinom fitting results in readme, WIP #38
eae3754
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@joshwlambert