Wrapper of goodpractice gp

gp_check(path = ".", checks = all_checkers(), extra_preps = all_prepers(),
  extra_checks = all_extra_checkers(), quiet = TRUE)

Arguments

path

Path to a data analysis root.

checks

Character vector, the checks to run. Defaults to all checks.

extra_preps

Custom preparation functions. See make_prep on creating preparation functions.

extra_checks

Custom checks.

quiet

Whether to suppress output from the preparation functions. Note that not all preparation functions produce output, even if this option is set to FALSE.

Value

A checkers object that you can query with a simple API. See results to start.

Examples

check_results <- gp_check(path=system.file("scripts", package="checkers"), checks = "comments", extra_preps = list(scripts = prep_scripts), extra_checks = list(comments = check_well_commented))
#> Preparing: scripts
check_results
#> #> Mmhm! Sensational package! Keep up the perfect work!