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

Add vignette on superspreading pipeline #16

Open
joshwlambert opened this issue May 24, 2023 · 6 comments
Open

Add vignette on superspreading pipeline #16

joshwlambert opened this issue May 24, 2023 · 6 comments
Labels
documentation Improvements or additions to documentation questioning Uncertain whether the issue should be addressed.

Comments

@joshwlambert
Copy link
Member

Issue #1 proposed having a vignette which included:

  1. Read in and tidy data
  2. Fit negative binomial model with {fitdistrplus}
  3. Apply summary metrics from {superspreading}
  4. Simulate with {bpmodels} with negative binomial parameters

Instead a vignette focussing on fitting distributions (#15) was added.

Here I reissue a request to write a vignette which covers the pipeline from initial data wrangling, to parameter estimation, to superspreading metrics and simulating with either {bpmodels} or {epichains}.

@joshwlambert joshwlambert added the documentation Improvements or additions to documentation label May 24, 2023
@adamkucharski
Copy link
Member

Agree, would be useful to have a full data-to-fitting-to-scenario pipeline illustrated (although the fitting distribution vignette is a nice stand-alone). Perhaps could also integrate with {ringbp} as @jamesmbaazam develops those options?

@jamesmbaazam
Copy link
Member

jamesmbaazam commented Jun 5, 2023

{epichains} is currently unstable/experimental to be used here. {bpmodels} provides a stable interface for this via chain_sim().

@joshwlambert
Copy link
Member Author

I'll use {bpmodels} for now with the aim to convert to using {epichains} once stable.

I'll track progress on epiverse-trace/epichains#6 and once there is a working version I can incorporate into {superspreading}.

@jamesmbaazam this could be a good topic of collaboration/cross-pillar work. Let me know if want to collaborate on this development.

@joshwlambert
Copy link
Member Author

Note: reproducing figure 1B from Ebola Superspreading using {bpmodels} for simulation would be a good fit for this vignette.

@jamesmbaazam
Copy link
Member

@joshwlambert I'm happy to work on this with you as these two projects are quite intertwined.

@joshwlambert joshwlambert added this to the v0.2.0 milestone Jun 13, 2023
@joshwlambert joshwlambert removed this from the v0.2.0 milestone Dec 15, 2023
@joshwlambert
Copy link
Member Author

Removing from v0.2.0 release as it needs to be reviewed whether such a pipeline is within the scope of the {superspreading} package. Possibly more suitable to case studies.

@joshwlambert joshwlambert added the questioning Uncertain whether the issue should be addressed. label Dec 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation questioning Uncertain whether the issue should be addressed.
Projects
None yet
Development

No branches or pull requests

3 participants