skills.rest
r-xla
r-xlaOFFICIAL
Explore all skills by this author →
GitHub

r-xla-prepare-pr

Regenerate documentation, run checks, and create a pull request for an R package.

Updated Mar 25, 2026
Search Tags:#testing#documentation#devtools#r#ci#pull-request#r-packages
One-click install
npx skills add https://github.com/r-xla/claude-config --skill r-xla-prepare-pr
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: r-xla-prepare-pr
Source: https://github.com/r-xla/claude-config/tree/main/skills/r-xla/prepare-pr
Command: npx skills add https://github.com/r-xla/claude-config --skill r-xla-prepare-pr

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Prepare an R package for a pull request by running checks, updating documentation, and ensuring tests pass within the package directory (the one that contains a DESCRIPTION file).

Core Features & Use Cases

  • Regenerate documentation to keep NAMESPACE and Rd files up to date.
  • Run linting, tests, and full R CMD check to ensure package health.
  • Update metadata docs (AGENTS.md, NEWS.md, and vignettes) and bump development version for PR readiness.
  • Create a PR using the /pr-create skill and monitor CI.

Quick Start

Run this workflow from inside your R package directory to generate a PR-ready state.

Frequently Asked Questions about r-xla-prepare-pr

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate R package checks before creating a pull request?▼

Automate R package checks before a pull request by running a workflow that regenerates documentation, executes linting and tests, and performs full R CMD check to ensure package health, producing a ready-to-review PR.

What is the best way to regenerate R package documentation and update metadata for a PR?▼

Regenerate R package documentation and update metadata for a PR by automatically rebuilding NAMESPACE and Rd files, then updating AGENTS.md, NEWS.md, and vignettes while bumping the development version for PR readiness.

Do I need to run R CMD check inside a specific directory to prepare my package?▼

Yes, you need to run R CMD check inside the package directory containing the DESCRIPTION file to ensure all documentation, testing, and packaging artifacts are generated in the correct context for PR readiness.

Can I automatically monitor CI status when creating an R package pull request?▼

Yes, you can automatically monitor CI status when creating an R package pull request because the preparation workflow coordinates with the /pr-create skill to submit the PR and track continuous integration results after checks pass.

Why does my R package PR fail CI checks even after local tests pass?▼

R package PR CI checks can fail after local tests pass if documentation is stale or metadata is incomplete. Running an end-to-end preparation workflow regenerates NAMESPACE, Rd files, and metadata to align artifacts with CI expectations.

Related Skills

Explore More Software Engineering Skills→
ivyleavedtoadflaxivyleavedtoadflax

rap-pipeline

Configures dependency-aware build automation for R projects using the {targets} package.

Community
Intermediate
marcioaltoemarcioaltoe
14

git-pr-creation

Create a GitHub pull request from the current branch into dev with a structured body.

Community
Advanced
kivo360kivo360
1

moai-lang-r

Enforce R 4.4+ best practices with testthat 3.2 and lintr 3.2 quality gates.

Community
Advanced
ab604ab604
189

r-package-development

Standardize R package development with roxygen2 documentation and testthat tests.

Community
Intermediate