README.Rmd

---
output: github_document
bibliography: vignettes/resources/references.json
link-citations: true
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# vimcheck: Diagnostics for Vaccine Impact Modelling Consortium burden and impact estimates

<!-- badges: start -->
[![Project Status: Concept – Minimal or no implementation has been done 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/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/vimcheck/branch/main/graph/badge.svg)](https://app.codecov.io/gh/vimc/vimcheck?branch=main)
[![CRAN status](https://www.r-pkg.org/badges/version/vimcheck)](https://CRAN.R-project.org/package=vimcheck)
<!-- badges: end -->

_vimcheck_ is an R package for running diagnostic checks on burden estimates submitted to the Vaccine Impact Modelling Consortium (VIMC), and on vaccine impact estimates calculated by VIMC.

## Installation

You can install the development version of _vimcheck_ from the VIMC R-universe with:

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

or from GitHub [GitHub](https://github.com/) with:

``` r
install.packages("pak")
pak::pak("vimc/vimcheck")
```

## Quick start

WIP.

## Related projects

VIMC impact assessment workflows are described in @echeverria-londono2021.

## References