Review Deprecated Functions

[donyunardi]

Summary

Let's review the functions we deprecated in the previous release and decide whether to hard deprecate them (lifecycle::deprecate_stop) or remove them from the codebase entirely.

Function	Action
init_filtered_data code and check argument	Remove

[m7pr]

Hey @donyunardi and @llrs-roche, besides code parts that we could change to from
deprecate_soft -> deprecated_hard or delete

I would also like us to have a look at things around

• lifecycle::stable
• lifecycle::experimental

I think we should review and change

• lifecycle::stable -> this was experimental some time ago, now this is stable, so let's just remove this badge
• lifecycle::experimental -> if this has been there for a while, and we did not decide to delete and no-one complained about it, I reckon we should change the badge to lifecycle::stable

What are your thoughs?

[llrs-roche]

The changes seem very easy and only involve modifying the documentation, and it is a good opportunity to deal with them before the release.
There are two stable parameters and two experimental ones.

• Stable:
  • choices_labels:

    teal.slice/R/choices_labeled.R

    Line 23 in a3d9a0f

    choices_labeled <- function(choices, labels, subset = NULL, types = NULL) {

  • get_filter_expr:

    teal.slice/R/filter_panel_api.R

    Line 169 in a3d9a0f

    get_filter_expr <- function(datasets, datanames = datasets$datanames()) {

• Experimental:
  • Managing FilteredData states

    teal.slice/R/filter_panel_api.R

    Line 3 in a3d9a0f

    #' @description `r lifecycle::badge("experimental")`

  • count_type parameter on teal_slices()

    teal.slice/R/teal_slices.R

    Line 20 in a3d9a0f

    #' @param count_type `r lifecycle::badge("experimental")`

[donyunardi]

Thanks for raising this.

While it makes sense to remove or transition the badge cycle, I want to ensure we're consistent across all teal packages. We should consider establishing guidelines, such as how long a function with an experimental badge should remain before becoming stable, and when the stable badge can be removed afterward. I also noticed that teal::init still has a stable badge.

To avoid scope creep on this issue, should we create a new issue to:

1. Discuss and decide on guidelines for transitioning lifecycle::badge in teal packages.
2. Implement changes based on the decision before the release.

[m7pr]

Alrighty, please create new issue and we will not increase the scope of this one

[donyunardi]

Issue created:
insightsengineering/nestdevs-tasks#86