tidy-deprecate-function

To deprecate an R function, use the lifecycle package to implement deprecate_warn, update Roxygen documentation with badges, modify tests to suppress warnings, and add NEWS.md entries for clear user communication during the function deprecation transition.

The best way to warn users during parameter deprecation is integrating lifecycle::deprecate_warn() within your R package code, which triggers automated warnings to notify users and guide them toward the replacement parameters.

You update Roxygen documentation for deprecated R functions by adding specific deprecation badges and migrating examples, ensuring the package documentation clearly communicates the lifecycle stage and directs users to alternative functions.

Yes, you need to modify package tests when deprecating R functions by silencing existing tests that trigger the new warnings and adding specific tests to verify the lifecycle deprecation warnings behave as expected.

Yes, devtools is included as a dependency to support the R package development workflow, working alongside lifecycle and withr to systematically implement and test function deprecations within your package environment.