Review teal.widgets documentation before release

[donyunardi]

Summary

Related with insightsengineering/nestdevs-tasks#13
In preparation to release teal.widgets, we need to review/assess all documentation in the package.

Acceptance Criteria

• Review roxygen examples on all functions
  • Test examples
  • If it's using chunk, update to qenv.
• Review all vignettes
  • Review any content around qenv
  • Review any content around chunks (i.e. make sure the right language around deprecation)
  • Review any content around shinyvalidate
• Update NEWS
• Update README (if applicable)
• Review DESCRIPTION file (i.e. dependency versions, etc)

[donyunardi]

Findings

• There is no relevant context around chunk or qenv from teal.code.
• All examples runs.
• minor fix in NEWS.
• README looks good.
• DESCRIPTION looks good.

[donyunardi]

I came across additional subjects that I believe are worth discussing in order to establish a consistent approach for documenting our functions. However, since these topics are not within the current scope of this issue, I will create a separate issue to address them and potentially establish guidelines.

Functions Documentation

• clean_brushedPoints
  • No examples
  • The description is a badge and the title is Cleans and organizes output to account for NAs and remove empty rows. Feels like the title should be in description and title should be something concise.
• get_dt_rows
  • The example is just conceptual on how to use the function, not an actual example that you could run. Although, it is wrapped in \dontrun{}.
  • The description is a badge and the title is Maps the lengthMenuselected value property of DT::datatable to a Shiny variable. Feels like the title should be in description and the title could be something concise.
  • Need to add space between the word lengthMenu and selected.
• updateOptionalSelectInput
  • Function is exported with no example. Need example.
• optionalSliderInput
  • Suggestion: If we include lifecycle badge, then add new line after the badge for readability.
  
• panel_group
  • The title is Panel group widget with no description other than lifecycle badge. Need more information.
  • Function is exported with no example. Need example.
• panel_item
  • The title is Panel widget with no description other than lifecycle badge. Need more information.
  • Function is exported with no example. Need example.
• plot_with_settings_ui
  • The title is UI part of plot-with-settings module with no description other than lifecycle badge. Need more information.
  • Function is exported with no example. Need example.
• plot_with_settings_srv
  • The title is Server part of plot-with-settings module with no description other than lifecycle badge. Need more information.
  • Function is exported with no example. Need example.
• standard_layout
  • Need example.
  • Enhance title and description
• table_with_settings_ui
  • Function is exported with no description. Need description.
• white_small_well
  • The description is a badge. Function is exported with no example. Need example.

Question

• Do we need lifecycle badge for stable functions? Should we only focus on badges for experimental or deprecated functions?