add_lifecycle_badge: Add a Life cycle badge

Description Usage Arguments Details Value See Also Examples

View source: R/add_lifecycle_badge.R

Description

This function adds or updates the Life cycle badge to the README.Rmd. It is based on the standard defined at https://lifecycle.r-lib.org/articles/stages.html.

Usage

1
add_lifecycle_badge(lifecycle = "experimental", quiet = FALSE)

Arguments

lifecycle

a character of length 1

Accepted stages are: 'experimental' (default), 'stable', 'deprecated', or 'superseded'.

quiet

a logical value

If TRUE messages are deleted. Default is FALSE.

Details

The project can have the following life cycle stage:

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_repostatus_badge()

Examples

1
2
3
4
5
## Not run: 
add_lifecycle_badge()
add_lifecycle_badge(lifecycle = "stable")

## End(Not run)

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