README.Rmd

---
output: github_document
---

<!-- 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%"
)
```

# popim

<!-- badges: start -->
[![R-CMD-check](https://github.com/mrc-ide/popim/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/mrc-ide/popim/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

**POPulation IMmunity**

This repository contains functions to run a demographic model of
vaccine exposure over time, tracking the vaccine-derived immunity by
age through time, following implementation of one or more vaccination
activities that can target the population as a whole or selectively
target specific age groups.

## Documentation

* For an illustration of how the package is used check the [main vignette](https://mrc-ide.github.io/popim/articles/popim.html).
* You can find more information about the underlying algorithms are in the [technical vignette](https://mrc-ide.github.io/popim/articles/technical_doc.html)

## Installation

You can install the development version of popim from
[GitHub](https://github.com/) with:

``` r
# Install `popim` in R:
install.packages('popim',repos = c('https://mrc-ide.r-universe.dev', 'https://cloud.r-project.org'))
```

<!-- You'll still need to render `README.Rmd` regularly, to keep -->
<!-- `README.md` up-to-date. `devtools::build_readme()` is handy for -->
<!-- this. You could also use GitHub Actions to re-render `README.Rmd` -->
<!-- every time you push. An example workflow can be found here: -->
<!-- <https://github.com/r-lib/actions/tree/v1/examples>. -->

<!-- You can also embed plots, for example: -->

<!-- ```{r pressure, echo = FALSE} -->
<!-- plot(pressure) -->
<!-- ``` -->

<!-- In that case, don't forget to commit and push the resulting figure -->
<!-- files, so they display on GitHub and CRAN. -->