tidy-deprecate-function

To deprecate an R function safely, insert lifecycle::deprecate_warn() into the target function, update roxygen docs with a deprecated badge, silence existing tests, and record the change in NEWS.md.

The best way to add lifecycle warnings in an R package is by using lifecycle::deprecate_warn(), which triggers a consistent deprecation message while ensuring users are notified of the function or argument's lifecycle status.

You calculate the deprecation version for an R package by reading the DESCRIPTION file to determine the current package version, which is then used to define the version when the function or argument was officially deprecated.

Updating documentation when deprecating R functions requires adding a lifecycle deprecated badge to roxygen docs and incorporating migration examples to guide users toward the new alternative functions or arguments.

To record deprecated functions in NEWS.md, add a deprecation note under the appropriate version section detailing which functions or arguments were deprecated, ensuring an auditable workflow of lifecycle changes.