Pre-release activities

[kartikeyakirar]

part of insightsengineering/nestdevs-tasks#48

• Review and update:
  - README.md (check example code)
  - NEWS.md
• Run urlchecker::url_check() to identify broken links and fix
• Review functions:
  - @example tag, make sure it runs, fix if otherwise
  - Make sure functions has @return tag to document the return value
  - no \dontrun tag, replace with if(interactive()) if needed
• Sanity check of all vignettes, make sure there is no typo, no wrong format, etc.
• Run R CMD check --as-cran make sure everything pass
• Package Title is not duplicated in Package Description in DESCRIPTION file (e.g. this happens in teal.slice currently)
• All package names in Title and Description fields of DESCRIPTION file are quoted with '
• You have checked the Package Release Template https://github.com/insightsengineering/teal.reporter/pull/205/files
• Make sure there are no ::: in examples
• Make sure all teal.* mentions are lower-cased and quoted
• Make Sure inst/WORDLIST is minimalized
• Make sure non-exported functions do not have examples
• Make sure each link to our documentation hosted with pkgdown on github pages do not have /main/ in the address but it has /latest/ instead, so we always expose the documentation of the latest release and not what's currently on main branch but not yet released
• remove old rd syntax
• switch from title case into sentence case for title and descriotion of functions.

[github-actions]

Code Coverage Summary

Filename                          Stmts    Miss  Cover    Missing
------------------------------  -------  ------  -------  -------------------------------------------------------------------------------------------------------------------------------
R/dummy_functions.R                  30      21  30.00%   21-33, 36-43
R/get_rcode_utils.R                  32       1  96.88%   51
R/include_css_js.R                   22       0  100.00%
R/init.R                             86      31  63.95%   107-114, 160-161, 163, 175-196, 226-227, 229
R/landing_popup_module.R             25      25  0.00%    61-87
R/module_filter_manager.R           107      36  66.36%   79-85, 92-100, 109-114, 237, 242-255
R/module_nested_tabs.R              154      58  62.34%   102-175, 191, 243, 265, 291
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, 343-366
R/module_tabs_with_filters.R         76      33  56.58%   92-127, 159, 175
R/module_teal_with_splash.R         114       4  96.49%   110, 131, 197-198
R/module_teal.R                     139      32  76.98%   81, 92, 101, 174-175, 181, 212, 220-221, 243-274
R/modules.R                         153      27  82.35%   120-123, 140-144, 199-203, 285-286, 338, 350-358, 438-441
R/reporter_previewer_module.R        18       2  88.89%   30, 34
R/show_rcode_modal.R                 19      19  0.00%    17-36
R/tdata.R                            53       1  98.11%   154
R/teal_data_module-eval_code.R       27       0  100.00%
R/teal_data_module-within.R           7       0  100.00%
R/teal_data_module.R                  6       0  100.00%
R/teal_reporter.R                    60       5  91.67%   65, 114-115, 118, 135
R/teal_slices-store.R                29       0  100.00%
R/teal_slices.R                      59      12  79.66%   137-150
R/utils.R                           147      27  81.63%   117-144
R/validate_inputs.R                  32       0  100.00%
R/validations.R                      58      37  36.21%   110-377
R/zzz.R                              11       7  36.36%   3-14
TOTAL                              1673     535  68.02%

Diff against main

Filename                        Stmts    Miss  Cover
----------------------------  -------  ------  --------
R/dummy_functions.R               -67     -67  +20.72%
R/include_css_js.R                 -2       0  +100.00%
R/init.R                          -10       0  -3.75%
R/module_nested_tabs.R             +3       0  +0.75%
R/module_tabs_with_filters.R       +3       0  +1.78%
R/module_teal.R                    -2      -1  +0.38%
R/modules.R                        +2      -6  +4.21%
R/show_rcode_modal.R               -1      -1  +100.00%
R/utils.R                          +5      -1  +1.35%
TOTAL                             -69     -76  +3.80%

Results for commit: 309e581

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

  1 files   19 suites   10s ⏱️
207 tests 207 ✅ 0 💤 0 ❌
418 runs  418 ✅ 0 💤 0 ❌

Results for commit 309e581.

♻️ This comment has been updated with latest results.

[github-actions]

Unit Test Performance Difference

Test Suite	$Status$	Time on main	$±Time$	$±Tests$	$±Skipped$	$±Failures$	$±Errors$
init	💚	$5.57$	$-5.14$	$-18$	$-1$	$0$	$0$
tdata	💔	$0.33$	$+5.30$	$0$	$-1$	$0$	$0$

Additional test case details

Test Suite	$Status$	Time on main	$±Time$	Test Case
init	💀	$0.09$	$-0.09$	init_data_accepts_a_list_of_a_single_MultiAssayExperiment_object_with_renaming
init	💀	$0.13$	$-0.13$	init_data_accepts_a_list_of_single_dataframe_with_renaming
init	💀	$0.03$	$-0.03$	init_data_accepts_a_list_of_single_dataframe_without_renaming
init	💀	$4.62$	$-4.62$	init_data_accepts_a_single_MultiAssayExperiment_object
init	💀	$0.04$	$-0.04$	init_data_accepts_a_single_dataframe
init	💀	$0.09$	$-0.09$	init_data_acceptsa_mixed_list_of_MultiAssayExperiment_object_and_data.frame
init	👶		$+0.03$	init_throws_when_an_empty_data_is_used
init	💀	$0.04$	$-0.04$	init_throws_when_data_has_no_datanames
init	👶		$+0.04$	init_throws_when_dataname_in_filter_incompatible_w_datanames_in_data
init	👶		$+0.03$	init_throws_when_datanames_in_modules_incompatible_w_datanames_in_data
init	💀	$0.05$	$-0.05$	init_throws_when_incompatible_filter_s_datanames
init	💀	$0.04$	$-0.04$	init_throws_when_incompatible_module_s_datanames
modules	👶		$+0.00$	format.teal_modules_returns_proper_structure
rcode_utils	👶		$+0.00$	When_teal.load_nest_code_option_is_not_character_get_rcode_str_install_silently_returns_default_string
rcode_utils	💀	$0.00$	$-0.00$	With_teal.load_nest_code_option_is_not_character_get_rcode_str_install_silently_returns_default_string
tdata	👶		$+0.01$	as_tdata_maintains_code_during_conversion
tdata	💀	$0.01$	$-0.01$	code_is_maintained_during_conversion
tdata	💔	$0.05$	$+5.25$	new_tdata_accepts_reactive_and_not_reactive_MAE_and_data.frames
utils	👶		$+0.01$	create_app_id_data_accepts_teal_data_or_teal_data_module
utils	👶		$+0.01$	create_app_id_modules_accepts_modules
utils	👶		$+0.00$	create_app_id_returns_a_character_string
utils	👶		$+0.01$	create_app_id_returns_different_hash_for_different_data
utils	👶		$+0.01$	create_app_id_returns_different_hash_for_different_modules
utils	👶		$+0.00$	defunction_recursively_goes_down_a_list
utils	👶		$+0.00$	defunction_returns_a_string_when_passed_a_function
utils	👶		$+0.01$	defunction_returns_non_function_atomic_as_is

Results for commit 31b599f

♻️ This comment has been updated with latest results.

addressed