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

Split vignette into topic-specific vignettes #75

Closed
4 of 9 tasks
joshwlambert opened this issue Dec 2, 2022 · 2 comments
Closed
4 of 9 tasks

Split vignette into topic-specific vignettes #75

joshwlambert opened this issue Dec 2, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@joshwlambert
Copy link
Member

joshwlambert commented Dec 2, 2022

The current vignette is relatively large and contains information on both the functionality of the epiparameter package and its integration with other packages. This can be confusing to people new to the package, therefore I suggest splitting the vignette into 1) core functionality (one vignette) and 2) applications (several vignettes).

Remove old vignette:

  • remove vignette

Core functionality:

  • Getting started (introduction to <epidist> and <epiparam> classes)
  • Using <epidist> and <epiparam> methods
  • Parameter conversion and extraction

Applications:

  • Quarantine
  • Transmissibility
  • Case-fatality rate
  • Superspreading

Auxiliary:

  • Parameter extraction bias
@joshwlambert
Copy link
Member Author

Instead of having one vignette per application, I will add a use-cases vignette which will include the topics included in the above description, but will not be extensive/comprehensive.

For more expansive applications of {epiparameter} the Epiverse-TRACE training materials (which are currently being worked on and will include more information on applying {epiparameter} in the future) can be used.

@joshwlambert
Copy link
Member Author

There is a now an ecosystem of documentation, training and how to guides within Epiverse-TRACE. Therefore, the application of {epiparameter} to other packages in the ecosystem or epidemiological tasks is no longer viewed necessary to be in this package.

Usage of {epiparameter} is included in other Epiverse-TRACE R packages, such as {superspreading} and {simulist}.

The suggested vignette on "Using <epidist> and <epiparam> methods" is now outdated as the <epiparam> class has been removed since #197 and the <epidist> class has been renamed <epiparameter> since #360.

Closing this issue, if vignettes outlining the application of {epiparameter} to epidemiological tasks are reconsidered to be needed this issue can be reopened.

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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant