README badges

Description

These helpers produce the markdown text you need in your README to include badges that report information, such as the CRAN version or test coverage, and link out to relevant external resources.

Usage

use_badge(badge_name, href, src)

use_cran_badge()

use_bioc_badge()

use_lifecycle_badge(stage)

use_binder_badge()

Arguments

Details

• use_badge(): a general helper used in all badge functions

• use_bioc_badge(): badge indicates BioConductor build status

• use_cran_badge(): badge indicates what version of your package is available on CRAN, powered by https://www.r-pkg.org

• use_lifecycle_badge(): badge declares the developmental stage of a package, according to https://www.tidyverse.org/lifecycle/:

  • Experimental

  • Maturing

  • Stable

  • Retired

  • Archived

  • Dormant

  • Questioning

• use_binder_badge(): badge indicates that your repository can be launched in an executable environment on https://mybinder.org/

See Also

The functions that set up continuous integration services also create badges.

Examples

## Not run: 
use_cran_badge()
use_lifecycle_badge("stable")

## End(Not run)