check_worcs {worcs} | R Documentation |
Evaluate project with respect to WORCS checklist
Description
Evaluates whether a project meets the criteria of the WORCS
checklist (see worcs_checklist
).
Usage
check_worcs(path = ".", verbose = TRUE)
Arguments
path |
Character. Path to a WORCS project folder (a project with a
|
verbose |
Logical. Whether or not to show status messages while
evaluating the checklist. Default: |
Value
A data.frame
with a description of the criteria, and a column
with evaluations ($pass
). For criteria that must be evaluated
manually, $pass
will be FALSE
.
Examples
example_dir <- file.path(tempdir(), "badge")
dir.create(example_dir)
write("a", file.path(example_dir, ".worcs"))
check_worcs(path = example_dir)
[Package worcs version 0.1.14 Index]