Review teal.slice documentations before release

[donyunardi]

Summary

Related with insightsengineering/nestdevs-tasks#25
We want to perform teal.slice release to introduce the first milestone of the filter panel upgrade.

Pre-req

• merge filter_panel_refactor@main to main #315

Acceptance Criteria

• Review and test roxygen examples
• Review vignettes
• Update NEWS
• Update README (if applicable)
• Review DESCRIPTION file (i.e. dependency versions, etc)

[chlebowa]

Example apps were added recently to illustrate the inner workings of FilterState and its children as well as DFFilterStates. Since then the api has changed, which was accompanied by making several methods private. $format has also changed. The example apps must be caught up to these changes, they may not even work properly now. This can be done on filter_panel_refactor@main.

[gogonzo]

From @chlebowa
Several changes have been made during the refactor without amending documentation. This must be done before merging to main.

examples

FilteredData

#' - `logical`: variable of type `logical`, e.g. `ADSL$TRT_FLAG`
#'      exactly one option must be selected, `TRUE` or `FALSE`

👆 logical need not select one

teal_slice

@param multiple (`logical(1)`)\cr

👆 inconsistent format; see also

#' Special consideration is given to two fields: `fixed` and `locked`.

👆 rewrite after multiple

examples

• example apps in FilterState* and FilterStatesDF to define states with teal_slice

...

[pawelru]

Hi @gogonzo @chlebowa can you please close it if it's finished?

[gogonzo]

Done