adds documentation

NEWS.md

@@ -1,6 +1,7 @@
 # dv.manager 2.1.4.9000
 
 - dv.manager filter hide/shows filters depending on the selected module
+- dv.manager dataset filters are now deactivated by default and can be activated by setting `use_dataset_filter` parameter in `run_app`.
 
 # dv.manager 2.1.4
 

R/run_app.R

@@ -26,6 +26,7 @@
 #' externally.
 #' @param reload_period Either a lubridate object to specify a duration
 #' or a positive numeric value which is then interpreted as a lubridate duration object in days. By default NULL
+#' @param use_dataset_filter a boolean flag indicating if dataset filters are used
 #' @param .launch by default it should always be TRUE. It should only be false for debugging and testing.
 #' When TRUE it will return the app. When FALSE it will return the options with which the app will be launched.
 #' @inheritParams shiny::shinyApp
@@ -47,7 +48,7 @@ run_app <- function(data = NULL,
                     azure_options = NULL,
                     reload_period = NULL,
                     enableBookmarking = "server", # nolint
-                    use_dataset_filter = FALSE,
+                    use_dataset_filter = TRUE,
                     .launch = TRUE) {
   check_deprecated_calls(filter_data)
 

vignettes/data_filtering.Rmd

@@ -39,10 +39,12 @@ The figure below depicts the steps of the filtering process when using the defau
 
 In a first step (1), `filter_data` makes a subselection of all subjects in the study according to the criteria selected by the user (in the case of the figure only female participants above 30 years). In a second step (2), we filter the rest of the datasets in `data` and only those subjects that survived the filtering in step 1 will remain.
 
-# Single filter
+# dataset filter
 
 **dv.manager** includes a filter for each of the datasets, with the exception of the one used in the population filter, that allows filtering the rows in that specific dataset. As opposed to the population filter
 this filter only affects the dataset itself and not the other datasets in the input data.
 
+This feature is optional can can be activated by setting `use_dataset_filter` parameter in `run_app`.
+