vimc.rpkg.template: TAGLINE

vimc.rpkg.template is a template package and repository on which future VIMC R packages are based.

To use this template, select vimc.rpkg.template from the drop-down menu under Repository template when creating a new repository in the VIMC GitHub organisation. Replace all instances of "vimc.rpkg.template" with your package name. Make sure to also:

1. Edit the DESCRIPTION as appropriate with the correct package information, including authors;

2. Edit the files in R/, tests/, and vignettes/ to suit your package;

3. Remove these instructions from README.Rmd. Then, either let the automated GitHub Actions workflow update README.md once the change is pushed to GitHub, or disable the workflow by removing the file .github/workflows/render-readme.yaml, and manually re-render the .md file using devtools::render_readme().

Installation

NOTE: Remove or comment out installation sources as appropriate.

Remember to add the package to the VIMC R-universe.

You can install the development version of vimc.rpkg.template from the VIMC R-universe with:

installation from R-universe
install.packages(
  "vimc.rpkg.template", 
  repos = c(
    "https://vimc.r-universe.dev", "https://cloud.r-project.org"
  )
)

or from GitHub GitHub with:

install.packages("pak")
pak::pak("vimc/vimc.rpkg.template")

Quick start

Add a simple example of using the package’s main feature(s) here, with a minimum amount of code. If preparatory or plotting steps are needed, prefer to hide them to keep focus on the package functionality.

Related projects

Add information and links to related projects, such as research papers or packages, here.

An example citation would be Echeverria-Londono et al. (2021).

References

Space for references: REMOVE this sub-section if there are no references. References, if any, should appear below this text. Remove this text in packages.

Echeverria-Londono, Susy, Xiang Li, Jaspreet Toor, Margaret J. De Villiers, Shevanthi Nayagam, Timothy B. Hallett, Kaja Abbas, et al. 2021. “How Can the Public Health Impact of Vaccination Be Estimated?” BMC Public Health 21 (1): 2049. https://doi.org/10.1186/s12889-021-12040-9.