tidy-deprecate-function
CommunitySafely deprecate R functions and parameters.
Authorbbtheo
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill provides a structured, step-by-step process for deprecating R functions or parameters, ensuring consistency, clear communication to users, and proper maintenance of R packages.
Core Features & Use Cases
- Guided Deprecation Workflow: Follows best practices for marking functions/parameters as deprecated.
- Automated Warnings: Integrates with
lifecycle::deprecate_warn()to notify users. - Documentation Updates: Guides on updating Roxygen documentation with deprecation badges and examples.
- Testing Integration: Includes steps for silencing existing tests and adding new tests for deprecation warnings.
- NEWS.md Entries: Ensures proper logging of deprecation in package changelogs.
- Use Case: When preparing to remove an older function in your R package, use this skill to systematically update its code, documentation, and tests to inform users and facilitate migration to a new replacement function.
Quick Start
Use the tidy-deprecate-function skill to deprecate the old_function() in favor of new_function().
Dependency Matrix
Required Modules
lifecyclewithrdevtoolsair
Components
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: tidy-deprecate-function Download link: https://github.com/bbtheo/cuplyr/archive/main.zip#tidy-deprecate-function Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.