tidy-deprecate-function

Deprecating an R function involves adding a lifecycle::deprecate_warn() call to emit a warning, updating tests to silence the warning, adding a lifecycle badge to documentation, creating a NEWS entry, and writing tests to verify the deprecation message displays correctly.

Deprecate a function argument by inserting lifecycle::deprecate_warn() for the parameter, silencing the warning in existing tests, documenting the deprecation with a lifecycle badge, adding a NEWS entry describing the change, and creating tests that confirm the deprecation warning triggers.

Silence deprecation warnings in existing tests using lifecycle's testing utilities, then create new tests specifically for the deprecation flow to verify the warning message and guidance to users is correct.

Add a lifecycle badge to your function documentation and create a NEWS entry that explains the deprecation, the recommended replacement, and the version in which the function will be removed.

Yes, this Skill handles both function-level and parameter-level deprecation cases, so you can deprecate multiple arguments in a single workflow while updating warnings, tests, docs, and NEWS consistently.

The Skill reads the deprecation version from your package's DESCRIPTION file, ensuring the version you assign to lifecycle::deprecate_warn() matches your package release cycle.