| add_dependencies_badge {rcompendium} | R Documentation |
Add a Dependencies badge
Description
This function adds or updates the Dependencies badge to the README.Rmd.
The first number corresponds to the direct dependencies and the second to the
recursive dependencies.
Note: this function can work with packages not published on the CRAN
and is based on the function gtools::getDependencies(). See also the
function get_all_dependencies().
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_dependencies_badge(quiet = FALSE)
Arguments
quiet |
A logical value. If |
Value
A badge as a markdown expression.
See Also
Other adding badges:
add_codecov_badge(),
add_cran_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_dependencies_badge()
## End(Not run)