tidy-deprecate-function

To deprecate an R function, add lifecycle warnings, update documentation with badges, and modify tests. This ensures users are informed while maintaining package quality during the transition.

Add deprecation warnings to R arguments using the lifecycle package. This Skill guides modifying function signatures and injecting warnings so users receive clear signals when using outdated parameters.

Managing R package lifecycle involves adding lifecycle badges, updating NEWS.md entries, and handling version management. This ensures comprehensive deprecation practices and clear communication of breaking changes.

Test deprecation warnings in R packages by modifying existing tests and adding new ones. This verifies that lifecycle warnings trigger correctly when deprecated functions or arguments are called.

Yes, the lifecycle package is required to deprecate R functions. It provides the necessary functions to implement soft-deprecation, warnings, and error stages for outdated code.

Yes, you can update R documentation and NEWS.md during function deprecation. This Skill guides adding lifecycle badges to docs and managing version entries to document the changes comprehensively.