This function adds or updates the License badge to the README.Rmd. This function reads the License field of the DESCRIPTION file. Ensure that this field is correctly defined. See add_license() for further detail.

This function requires the presence of a DESCRIPTION file at the project root. See add_description() for further detail.

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.

add_license_badge(quiet = FALSE)

Arguments

quiet

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

Value

A badge as a markdown expression.

Examples

if (FALSE) {
add_license_badge()
}