add_repostatus_badge: Add a Repository status badge

Description Usage Arguments Details Value See Also Examples

View source: R/add_repostatus_badge.R

Description

This function adds or updates the Repo Status badge of the project to the README.Rmd. It is based on the standard defined by the https://www.repostatus.org project.

Usage

1
add_repostatus_badge(status = "concept", quiet = FALSE)

Arguments

status

a character of length 1

Accepted status are: 'concept' (default), 'wip', 'suspended', 'abandoned', 'active', 'inactive', or 'unsupported'.

quiet

a logical value

If TRUE messages are deleted. Default is FALSE.

Details

The project can have the following status:

Value

A Markdown badge expression

See Also

Other adding badges: add_codecov_badge(), add_cran_badge(), add_dependencies_badge(), add_github_actions_check_badge(), add_github_actions_codecov_badge(), add_github_actions_pkgdown_badge(), add_license_badge(), add_lifecycle_badge()

Examples

1
2
3
4
5
## Not run: 
add_repostatus_badge()
add_repostatus_badge(status = "active")

## End(Not run)

rcompendium documentation built on March 24, 2021, 5:06 p.m.