pkgdown

Author: gogonzo

R/0-as_picks.R

@@ -1,5 +1,7 @@
 #' Convert data_extract_spec to picks
 #'
+#' @description
+#' `r lifecycle::badge("experimental")`
 #' Helper functions to ease transition between [data_extract_spec()] and [picks()].
 #' @inheritParams teal::teal_transform_module
 #' @param x (`data_extract_spec`, `select_spec`, `filter_spec`) object to convert to [`picks`]

R/0-module_picks.R

@@ -1,7 +1,6 @@
 #' Interactive picks
 #'
 #' @description
-#' `r lifecycle::badge("experimental")`
 #'
 #' Creates UI and server components for interactive [picks()] in Shiny modules. The module is based on
 #' configuration provided via [picks()] and its responsibility is to determine relevant input
@@ -315,6 +314,7 @@ picks_srv.picks <- function(id, picks, data) {
 #' @param rv (`reactiveVal`)
 #' @param value (`vector`)
 #' @param log (`character(1)`) message to `log_debug`
+#' @keywords internal
 .update_rv <- function(rv, value, log) {
   if (!isTRUE(all.equal(rv(), value, tolerance = 1e-15))) { # tolerance 1e-15 is a max precision in widgets.
     logger::log_debug(log)

R/0-tidyselect-helpers.R

@@ -1,6 +1,8 @@
 #' `tidyselect` helpers
 #'
-#'
+#' @description
+#' #' `r lifecycle::badge("experimental")`
+#' Predicate functions simplifying `picks` specification.
 #' @examples
 #' # select factor column but exclude foreign keys
 #' variables(choices = is_categorical(min.len = 2, max.len = 10))

_pkgdown.yml

@@ -65,3 +65,28 @@ reference:
   - title: Human-readable formatting of a data extract object
     contents:
       - format_data_extract
+  - title: Picks
+    desc: >-
+      Picks contructors
+    contents:
+      - picks
+      - datasets
+      - variables
+      - values
+  - title: Shiny modules
+    desc: >-
+      Modules to interactively select-and-merge
+    contents:
+      - merge_srv
+      - picks_srv
+      - picks_ui
+      - tm_merge
+  - title: Picks utilities
+    desc: >-
+      Additional tools to help working with picks 
+    contents:
+      - as.picks
+      - is_categorical
+      - resolver
+      - teal_transform_filter
+