add_badges: Add badges to the README file for use on Github

In hgutils: Collection of Utility Functions

Add badges to the README file for use on Github

Description

Add badges to the README file for use on Github

Usage

add_badges(
  github_pkg,
  states = c("active", "abandoned", "concept", "inactive", "moved", "suspended",
    "unsupported", "wip"),
  readme_file = "README.md",
  show_repo_status = TRUE,
  show_cran_version = TRUE,
  show_package_version = TRUE,
  show_min_r = TRUE,
  show_last_update = TRUE,
  show_travis = TRUE,
  show_code_coverage = TRUE
)

Arguments

github_pkg	The Github repository
states	Current software cycle state
readme_file	The filename of the readme file
show_repo_status	Whether to show the repository status as a badge
show_cran_version	Whether to show the CRAN version as a badge
show_package_version	Whether to show the package version as a badge
show_min_r	Whether to show the minimal R version as a badge
show_last_update	Whether to show the last update date as a badge
show_travis	Whether to show the Travis test results as a badge (see https://travis-ci.org)
show_code_coverage	Whether to show the code coverage as a badge (see https://about.codecov.io/)

Examples

## Not run: 
add_badges("hvdboorn/hgutils")

## End(Not run)

hgutils documentation built on March 31, 2022, 5:06 p.m.