README.Rmd

---
output: github_document
---

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

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)
```

# premiumPlots

[![R build status](https://github.com/simisc/premiumPlots/workflows/R-CMD-check/badge.svg)](https://github.com/simisc/premiumPlots/actions)
[![DOI](https://zenodo.org/badge/120929260.svg)](https://zenodo.org/badge/latestdoi/120929260)
[![Licence](https://img.shields.io/github/license/simisc/premiumPlots)](https://github.com/simisc/premiumPlots/blob/master/LICENSE)
[![Lifecycle](https://img.shields.io/badge/lifecycle-dormant-blue.svg)](https://www.tidyverse.org/lifecycle/#dormant)

Plot results and diagnostics for profile regression models fitted using the `PReMiuM` package (Liverani et al 2013).

## Installation

You can install premiumPlots from github with:

```{r gh-installation, eval = FALSE}
# install.packages("devtools")
devtools::install_github("simisc/premiumPlots")
```

## Example

To do.