Automatic readme update

Author: actions-user

README.md

@@ -1,7 +1,7 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# vimc.rpkg.template: TAGLINE
+# vimcheck: Diagnostics for vaccination modelling burden and impact estimates
 
 <!-- badges: start -->
 
@@ -10,47 +10,26 @@ yet, or the repository is only intended to be a limited example, demo,
 or
 proof-of-concept.](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept)
 [![R build
-status](https://github.com/vimc/vimc.rpkg.template/workflows/R-CMD-check/badge.svg)](https://github.com/vimc/vimc.rpkg.template/actions/workflows/R-CMD-check.yaml)
+status](https://github.com/vimc/vimcheck/workflows/R-CMD-check/badge.svg)](https://github.com/vimc/vimcheck/actions/workflows/R-CMD-check.yaml)
 [![Codecov test
-coverage](https://codecov.io/gh/vimc/vimc.rpkg.template/branch/main/graph/badge.svg)](https://app.codecov.io/gh/vimc/vimc.rpkg.template?branch=main)
+coverage](https://codecov.io/gh/vimc/vimcheck/branch/main/graph/badge.svg)](https://app.codecov.io/gh/vimc/vimcheck?branch=main)
 [![CRAN
-status](https://www.r-pkg.org/badges/version/vimc.rpkg.template)](https://CRAN.R-project.org/package=vimc.rpkg.template)
+status](https://www.r-pkg.org/badges/version/vimcheck)](https://CRAN.R-project.org/package=vimcheck)
 <!-- badges: end -->
 
-*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.  Add spell check by running
-    `usethis::use_spell_check(lang = "en-GB")`;
-
-4.  Remove these instructions from `README.Rmd`, and re-render the `.md`
-    file using `devtools::render_readme()`.
+*vimcheck* is an R package for running diagnostic checks on burden
+estimates submitted to the Vaccine Impact Modelling Consortium (VIMC),
+and on impact estimates calculated by VIMC.
 
 ## Installation
 
-**NOTE:** Remove or comment out installation sources as appropriate.
-
-**Remember** to add the package to the [VIMC
-R-universe](https://github.com/vimc/vimc.r-universe.dev).
-
-You can install the development version of *vimc.rpkg.template* from the
-VIMC R-universe with:
+You can install the development version of *vimcheck* from the VIMC
+R-universe with:
 
 ``` r
 installation from R-universe
 install.packages(
-  "vimc.rpkg.template", 
+  "vimcheck", 
   repos = c(
     "https://vimc.r-universe.dev", "https://cloud.r-project.org"
   )
@@ -61,20 +40,31 @@ or from GitHub [GitHub](https://github.com/) with:
 
 ``` r
 install.packages("pak")
-pak::pak("vimc/vimc.rpkg.template")
+pak::pak("vimc/vimcheck")
 ```
 
 ## 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.
+WIP.
 
 ## Related projects
 
-Add information and links to related projects, such as research papers
-or packages, here.
+VIMC impact assessment workflows are described in Echeverria-Londono et
+al. ([2021](#ref-echeverria-londono2021)).
 
 ## References
 
-Space for references: REMOVE this text.
+<div id="refs" class="references csl-bib-body hanging-indent"
+entry-spacing="0">
+
+<div id="ref-echeverria-londono2021" class="csl-entry">
+
+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>.
+
+</div>
+
+</div>