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

New formula for proportion transmission #99

Merged

Conversation

dcadam
Copy link
Contributor

@dcadam dcadam commented Aug 19, 2024

New formula for proportion of transmission which addresses issue #93

@joshwlambert
Copy link
Member

@dcadam thanks for making this contribution! I've integrated your new function, proportion_transmission2() into proportion_transmission() and added a method argument that allows users to switch between the "p_80" (original) method and the "t_20" (newly contributed) method. I've integrated the documentation you've provided into the existing proportion_transmission() documentation, this can be viewed with ?proportion_transmission().

The new functionality benefits from all of the existing input checking that proportion_transmission() already had.

I've also added unit tests to make sure the new functionality is working as expected.

As this PR is a great enhancement to the package, I've added you as a package author. Please let me know that you're okay with this before I merge the PR.

Once this PR is merged, I'll try and write a vignette that explores the difference between the two proportion_transmission() methods ($p_{80}$ and $t_{20}$) to make clear to users of the package when to use each and some of the background theory to both approaches. It would be great if you'd review this vignette once I've drafted something.

@dcadam
Copy link
Contributor Author

dcadam commented Aug 23, 2024

@joshwlambert Thanks for including me. Happy to listed as a package author for this, and to help review the vignette when needed.

@joshwlambert joshwlambert force-pushed the new-formula-for-proposed-transmission branch from 308f004 to 1a93343 Compare August 28, 2024 09:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants