From ce5ea10ca6b477440c46910d3d3f6e0cc32b9fe5 Mon Sep 17 00:00:00 2001 From: jamesaazam Date: Tue, 18 Jun 2024 11:03:18 +0100 Subject: [PATCH] Add retirement badge and note in README --- README.Rmd | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.Rmd b/README.Rmd index edb99ff..0f53f77 100644 --- a/README.Rmd +++ b/README.Rmd @@ -16,6 +16,7 @@ knitr::opts_chunk$set( # _bpmodels_: Methods for simulating and analysing the size and length of transmission chains from branching process models +[![Lifecycle: retired](https://img.shields.io/badge/lifecycle-retired-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#retired) ![GitHub R package version](https://img.shields.io/github/r-package/v/epiverse-trace/bpmodels) [![R-CMD-check](https://github.com/epiverse-trace/bpmodels/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/epiverse-trace/bpmodels/actions/workflows/R-CMD-check.yaml) [![codecov](https://codecov.io/github/epiverse-trace/bpmodels/branch/main/graph/badge.svg)](https://app.codecov.io/github/epiverse-trace/bpmodels) @@ -23,6 +24,10 @@ knitr::opts_chunk$set( [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/MIT/) +## Note + +> `{bpmodels}` is now *retired and will no longer be maintained*. We recommend using [`{epichains}`](https://github.com/epiverse-trace/epichains) instead. If you need help converting your code to use `{epichains}`, please [open a discussion on epichains](https://github.com/epiverse-trace/epichains/discussions). + ```{r setup, include=FALSE} knitr::opts_chunk$set(echo = TRUE) ```