Skip to contents

Add a CRAN version badge

Source: R/add_cran_version_badge.R
add_cran_version_badge.Rd

This function adds a CRAN Status (i.e. CRAN version) badge to the README.Rmd. If the package is not hosted on the CRAN the badge will indicate not published on the CRAN.

Make sure that 1) a README.Rmd file exists at the project root and 2) it contains a block starting with the line <!-- badges: start --> and ending with the line <!-- badges: end -->.

Don't forget to re-render the README.md.

Usage

add_cran_version_badge(quiet = FALSE)

Arguments

quiet

A logical value. If TRUE messages are deleted. Default is FALSE.

Value

A badge as a markdown expression.

See also

Other adding badges: add_codecov_badge(), add_cran_downloads_badge(), add_cran_total_download_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(), add_repostatus_badge()

Examples

if (FALSE) { # \dontrun{
add_cran_version_badge()
} # }