fixes the relationship between `module_specific` and `mapping`. #968

kartikeyakirar · 2023-11-21T12:19:11Z

fixes: #966

Example

# module_specific is not specified
teal_slices(
    # filters created with id
    teal_slice(dataname = "mtcars", varname = "mpg", id = "filter 1"),
    teal_slice(dataname = "mtcars", varname = "cyl", id = "filter 2"),
    teal_slice(dataname = "mtcars", varname = "disp", id = "filter 3"),
    teal_slice(dataname = "mtcars", varname = "hp", id = "filter 4"),
    teal_slice(dataname = "mtcars", varname = "drat", id = "filter 5"),
    teal_slice(dataname = "mtcars", varname = "wt", id = "filter 6"),
    
    # filters mapped to modules
    mapping = list(
        "module 1" = c("filter 2", "filter 4"),
        "module 2" = "filter 3",
        "module 3" = "filter 2",
        global_filters = "filter 1"
    )
)
############output############
filter
{
  "slices": [
    {
      "dataname"       : "mtcars",
      "varname"        : "mpg",
      "id"             : "filter 1",
      "fixed"          : false,
      "anchored"       : false,
      "multiple"       : true
    },
    {
      "dataname"       : "mtcars",
      "varname"        : "cyl",
      "id"             : "filter 2",
      "fixed"          : false,
      "anchored"       : false,
      "multiple"       : true
    },
    {
      "dataname"       : "mtcars",
      "varname"        : "disp",
      "id"             : "filter 3",
      "fixed"          : false,
      "anchored"       : false,
      "multiple"       : true
    },
    {
      "dataname"       : "mtcars",
      "varname"        : "hp",
      "id"             : "filter 4",
      "fixed"          : false,
      "anchored"       : false,
      "multiple"       : true
    },
    {
      "dataname"       : "mtcars",
      "varname"        : "drat",
      "id"             : "filter 5",
      "fixed"          : false,
      "anchored"       : false,
      "multiple"       : true
    },
    {
      "dataname"       : "mtcars",
      "varname"        : "wt",
      "id"             : "filter 6",
      "fixed"          : false,
      "anchored"       : false,
      "multiple"       : true
    }
  ],
  "attributes": {
    "allow_add"        : true,
    "mapping"          : {
      "module 1"       : ["filter 2", "filter 4"],
      "module 2"       : "filter 3",
      "module 3"       : "filter 2",
      "global_filters" : "filter 1"
    },
    "module_specific"  : true
  }
}

github-actions · 2023-11-21T12:23:09Z

Code Coverage Summary

Filename                         Stmts    Miss  Cover    Missing
-----------------------------  -------  ------  -------  -------------------------------------------------------------------------------------------------------------------------------
R/dummy_functions.R                 92      50  45.65%   9-71
R/get_rcode_utils.R                 46       1  97.83%   49
R/include_css_js.R                  24       0  100.00%
R/init.R                            79      25  68.35%   143, 168-189, 221-223, 225-227, 229-230
R/landing_popup_module.R            25      25  0.00%    61-87
R/module_filter_manager.R          107      29  72.90%   62-70, 79-84, 228, 233-246
R/module_nested_tabs.R             176      14  92.05%   72, 119, 138-145, 163, 216, 238, 271
R/module_snapshot_manager.R        209     157  24.88%   87-99, 127-136, 140-152, 154-161, 168-182, 186-188, 190-195, 198-208, 211-227, 236-251, 265-288, 291-302, 305-311, 325, 346-369
R/module_tabs_with_filters.R        73       2  97.26%   95, 140
R/module_teal_with_splash.R        119      11  90.76%   73, 83-91, 122
R/module_teal.R                    141       8  94.33%   68, 71, 158-159, 165, 195, 203-204
R/modules_debugging.R               18      18  0.00%    25-44
R/modules.R                        143      26  81.82%   119, 132, 226-229, 243-248, 259-263, 378-421
R/reporter_previewer_module.R       18       2  88.89%   26, 30
R/show_rcode_modal.R                20      20  0.00%    16-37
R/tdata.R                           39       1  97.44%   158
R/teal_data_module.R                 6       0  100.00%
R/teal_reporter.R                   60       5  91.67%   65, 116-117, 120, 137
R/teal_slices-store.R               25       0  100.00%
R/teal_slices.R                     66      12  81.82%   147-160
R/utils.R                          110      27  75.45%   113-140
R/validate_inputs.R                 32       0  100.00%
R/validations.R                     58      37  36.21%   109-371
R/zzz.R                             11       7  36.36%   3-14
TOTAL                             1697     477  71.89%

Diff against main

Filename           Stmts    Miss  Cover
---------------  -------  ------  -------
R/teal_slices.R       +7       0  +2.16%
TOTAL                 +7       0  +0.12%

Results for commit: 54b8324

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

github-actions · 2023-11-21T12:24:27Z

Unit Tests Summary

    1 files   18 suites 12s ⏱️
197 tests 197 ✔️ 0 💤 0 ❌
374 runs 374 ✔️ 0 💤 0 ❌

Results for commit 54b8324.

github-actions · 2023-11-21T12:24:33Z

Unit Test Performance Difference

Additional test case details

Test Suite	$Status$	Time on `main`	$±Time$	Test Case
module_teal	👶		$+0.03$	srv_teal_initialized_data_containing_same_FilteredData_when_module_specific_is_not_specified
teal_slices	👶		$+0.02$	teal_slices_dynamically_calculates_module_specific

Results for commit 6275ace

♻️ This comment has been updated with latest results.

chlebowa · 2023-11-21T12:27:16Z

R/teal_slices.R

+#'  If `module_specific` is not provided, its value is inferred based on the `mapping` parameter:
+#'    - If `mapping` is provided and non-empty, `module_specific` is set to `TRUE`.
+#'    - If `mapping` is missing or empty, `module_specific` defaults to `FALSE`.
+#'  This behavior allows for dynamic determination of filter panel specificity based on the provided `mapping`.


Suggested change

#' This behavior allows for dynamic determination of filter panel specificity based on the provided `mapping`.

chlebowa · 2023-11-21T12:28:03Z

R/teal_slices.R

@@ -14,6 +14,11 @@
 #'   of filters specified - see `mapping` argument.
 #'  - `FALSE` when one filter panel needed to all modules. All filters will be shared
 #'    by all modules.
+#'  Note: This parameter does not have a default value and should be explicitly provided.


Suggested change

#' Note: This parameter does not have a default value and should be explicitly provided.

chlebowa · 2023-11-21T12:29:11Z

R/teal_slices.R

+#'  If `module_specific` is not provided, its value is inferred based on the `mapping` parameter:
+#'    - If `mapping` is provided and non-empty, `module_specific` is set to `TRUE`.
+#'    - If `mapping` is missing or empty, `module_specific` defaults to `FALSE`.


Suggested change

#' If `module_specific` is not provided, its value is inferred based on the `mapping` parameter:

#' - If `mapping` is provided and non-empty, `module_specific` is set to `TRUE`.

#' - If `mapping` is missing or empty, `module_specific` defaults to `FALSE`.

#' Defaults to `TRUE` if `mapping` provided, otherwise to `FALSE`.

chlebowa · 2023-11-21T12:30:13Z

NEWS.md

@@ -5,6 +5,7 @@
 * `data` argument in `init` now accepts `teal_data` and `teal_data_module`.
 * Added `landing_popup_module` function which creates a module that will display a popup when the app starts. The popup will block access to the app until it is dismissed.
 * Filter state snapshots can now be uploaded from file. See `?snapshot`.
+* Removed default value for `module_specific` from `teal_slices`, now dynamically determined based on mapping content—if mapping is provided and non-empty, `module_specific` defaults to `TRUE`, otherwise to `FALSE`.


Suggested change

* Removed default value for `module_specific` from `teal_slices`, now dynamically determined based on mapping content—if mapping is provided and non-empty, `module_specific` defaults to `TRUE`, otherwise to `FALSE`.

* Removed default value for `module_specific` argument in `teal_slices`. The default value now depends on the `mapping` argument.

kartikeyakirar · 2023-11-21T13:23:15Z

closing this PR based on comment #966 (comment).

kartikeyakirar added 5 commits November 21, 2023 15:33

removing default and adding documentation

9566ae6

fixing condition

7b09fc8

adding test

a5a8d83

test for dynamic module_specific.

bc8047f

updated news

54b8324

kartikeyakirar added the core label Nov 21, 2023

chlebowa suggested changes Nov 21, 2023

View reviewed changes

kartikeyakirar closed this Nov 21, 2023

kartikeyakirar deleted the 966_fixing_mapping@main branch November 21, 2023 14:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fixes the relationship between `module_specific` and `mapping`. #968

fixes the relationship between `module_specific` and `mapping`. #968

kartikeyakirar commented Nov 21, 2023

github-actions bot commented Nov 21, 2023

github-actions bot commented Nov 21, 2023

github-actions bot commented Nov 21, 2023

chlebowa Nov 21, 2023

chlebowa Nov 21, 2023

chlebowa Nov 21, 2023

chlebowa Nov 21, 2023

kartikeyakirar commented Nov 21, 2023

	* Removed default value for `module_specific` from `teal_slices`, now dynamically determined based on mapping content—if mapping is provided and non-empty, `module_specific` defaults to `TRUE`, otherwise to `FALSE`.
	* Removed default value for `module_specific` argument in `teal_slices`. The default value now depends on the `mapping` argument.

fixes the relationship between module_specific and mapping. #968

fixes the relationship between module_specific and mapping. #968

Conversation

kartikeyakirar commented Nov 21, 2023

github-actions bot commented Nov 21, 2023

Code Coverage Summary

Diff against main

github-actions bot commented Nov 21, 2023

Unit Tests Summary

github-actions bot commented Nov 21, 2023

Unit Test Performance Difference

chlebowa Nov 21, 2023

Choose a reason for hiding this comment

chlebowa Nov 21, 2023

Choose a reason for hiding this comment

chlebowa Nov 21, 2023

Choose a reason for hiding this comment

chlebowa Nov 21, 2023

Choose a reason for hiding this comment

kartikeyakirar commented Nov 21, 2023

fixes the relationship between `module_specific` and `mapping`. #968

fixes the relationship between `module_specific` and `mapping`. #968