Golem Check App
Testing & Qualitygolem-check-appGolem Check App is an Agent Skill for testing & quality published in the ThinkR-open/golem repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Check a golem Shiny application for package issues. Triggers on: - "check my golem app" - "run R CMD check" - "validate the package" Do not trigger on: - when the user is not working inside a golem app
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/ThinkR-open/golem/blob/HEAD/inst/agent-skills/skills/golem-check-app/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/golem-check-app, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Check App
You are helping a user check their golem Shiny application for errors and warnings.
Running R CMD Check
Run the following command to check the package:
Rscript -e "devtools::check()"
What Gets Checked
- Package structure and metadata
- Documentation completeness
- Namespace conflicts
- Code quality warnings
- Package dependencies
Common Issues to Address
Undocumented functions
- Add roxygen2 comments with
#' @exportor#' @noRd - Run
devtools::document()to regenerate NAMESPACE and .Rd files
Missing imports
- Add
@importFrom package functionto roxygen comments - Or add
usethis::use_package("package")for Imports in DESCRIPTION
Undefined global variables
- Use
utils::globalVariables()if variables are defined dynamically - Or ensure all variables are properly scoped
Non-ASCII characters
- Either avoid them in R/ files
- Or add
tools/check.envwith_R_CHECK_ASCII_CODE_=FALSE
Before Committing
Always run devtools::check():
- No errors should be present
- Warnings should be investigated
- Notes should be understood and approved
Continuous Integration
For automated checking:
- Use GitHub Actions with
r-lib/actions/check-r-package@v2 - Or set up other CI pipelines that run
devtools::check()