Package index • goodpractice

Main functions

goodpractice-package: goodpractice: Advice on R Package Building
gp(): Run good practice checks

Check control

checks(): List all checks performed
make_prep() make_check(): Defining custom preparations and checks
failed_checks(): Names of the failed checks
failed_positions(): Positions of check failures in the source code

Check groups

all_check_groups(): List available check group names
all_checks(): List the names of all checks
checks_by_group(): Select checks by check group
default_checks(): List the names of default checks (excludes optional check sets)
describe_check(): Describe one or more checks
describe_check_groups(): Describe available check groups
tidyverse_checks(): List the names of tidyverse style checks

Agent skills

learn_skill_gp(): Function for AI agents to run and learn how to use the 'goodpractice' package.
use_skill_gp(): Download a local copy of 'goodpractice4agents.md' to tell AI agents how to use this package.

Output control

export_json(): Export failed checks to JSON
print(<goodPractice>): Print goodpractice results
results(): Return all check results in a data frame