worcs_badge | R Documentation |
Evaluates whether a project meets the criteria of the WORCS
checklist (see worcs_checklist
), and adds a badge to the
project's README.md
.
worcs_badge( path = ".", update_readme = "README.md", update_csv = "checklist.csv" )
path |
Character. This can either be the path to a WORCS project folder
(a project with a |
update_readme |
Character. Path to the |
update_csv |
Character. Path to the |
No return value. This function is called for its side effects.
example_dir <- file.path(tempdir(), "badge") dir.create(example_dir) write("a", file.path(example_dir, ".worcs")) worcs_badge(path = example_dir, update_readme = NULL)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.