add_codecov_badge: Add a Codecov badge

In FRBCesab/rcompendium: Create a Package or Research Compendium Structure

Add a Codecov badge

Description

This function adds a Code coverage badge to the README.Rmd, i.e. the percentage of code cover by units tests. This percentage is computed by the codecov.io service.

Note: this service must be manually activated for the package by visiting https://about.codecov.io/.

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_codecov_badge(organisation = NULL, quiet = FALSE)

Arguments

organisation	A character of length 1. The name of the GitHub organisation to host the package. If NULL (default) the GitHub account will be used.
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_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(), add_repostatus_badge()

Examples

## Not run: 
add_codecov_badge()

## End(Not run)

FRBCesab/rcompendium documentation built on Nov. 15, 2024, 9:38 p.m.