Review teal.slice documentation before release

R/calls_combine_by.R

@@ -12,13 +12,21 @@
 #'
 #' @examples
 #' \dontrun{
+#' fs_ch <- ChoicesFilterState$new(x = c("F", "M"), varname = "SEX")
+#' fs_ch$set_state(list(selected = c("F")))
+#'
+#' fs_rng <- RangeFilterState$new(x = 1:100, varname = "AGE")
+#' fs_rng$set_state(list(selected = c(20, 50)))
+#'
+#' fs_log <- LogicalFilterState$new(x = c(TRUE, FALSE), varname = "SURV")
+#' fs_log$set_state(list(selected = TRUE))
+#'
 #' calls <- list(
-#'   call_condition_choice("SEX", "F"),
-#'   call_condition_range("AGE", c(20, 50)),
-#'   call_condition_choice("ARM", "ARM: A"),
-#'   call_condition_logical("SURV", TRUE)
+#'   shiny::isolate(fs_ch$get_call()),
+#'   shiny::isolate(fs_rng$get_call()),
+#'   shiny::isolate(fs_log$get_call())
 #' )
-#' calls <- lapply(calls, str2lang)
+#'
 #' calls_combine_by(calls, "&")
 #' }
 #' @return a combined `call`

vignettes/teal-slice.Rmd

@@ -95,9 +95,11 @@ if (interactive()) {
 The `FilteredData` object (`datasets` above) provides additional methods (such as `datasets$get_call(<dataname>)` to get the code used to filter the data) and is also possible to programmatically set the state of the filter panel using the `set_filter_state` function for example:
 
 ```{r, eval=FALSE}
-set_filter_state(
-  datasets,
-  list(iris = list(Species = list(selected = c("setosa", "versicolor"))))
+shiny::isolate(
+  set_filter_state(
+    datasets,
+    list(iris = list(Species = list(selected = c("setosa", "versicolor"))))
+  )
 )
 ```