add_github_actions_codecov_badge: Add a Test coverage badge

Description Usage Arguments Value See Also Examples

View source: R/add_github_actions_codecov_badge.R

Description

This function adds a Test coverage badge to the README.Rmd. This function must be run after add_github_actions_codecov() which will setup GitHub Actions to report the percentage of code cover by units tests.

Usage

1
add_github_actions_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 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_pkgdown_badge(), add_license_badge(), add_lifecycle_badge(), add_repostatus_badge()

Examples

1
2
3
4
## Not run: 
add_github_actions_codecov_badge()

## End(Not run)

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