dynamic_badges_minimal {badgecreatr}R Documentation

Add dynamic content to readme

Description

This function returns markdown that you must place in the readme. This is dynamic content. This function returns a RMarkdown piece that does some calculation and a set of badges are placed underneath the code part.

Usage

dynamic_badges_minimal(status = "concept", license = NULL,
  last_change = TRUE, minimal_r_version = TRUE, travisfile = NULL,
  codecov = NULL, location = ".")

Arguments

status

one of concept, wip, suspended, abandoned, active, inactive or unsupported

license

one of GPL-3, GPL-2, MIT, or CC0.

last_change

adding a last change badge? TRUE or FALSE

minimal_r_version

adding minimal r version badge? TRUE or FALSE

travisfile

add a travis statusbadge

codecov

add a codecov badge

location

defaults to current location

Value

text to put into rmd file

See Also

Other scenarios: minimal_badges

Examples

## Not run: 
dynamic_badges_minimal(status = "active",last_change = FALSE,minimal_r_version = FALSE) 

## End(Not run)

[Package badgecreatr version 0.2.0 Index]