Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

624 PACKAGE LEVEL pre-release activities #639

Merged
merged 70 commits into from
Mar 1, 2024
Merged

624 PACKAGE LEVEL pre-release activities #639

merged 70 commits into from
Mar 1, 2024

Conversation

m7pr
Copy link
Contributor

@m7pr m7pr commented Feb 19, 2024

Part of #624

  • Review and update README.md
    • check example code
    • add CRAN BADGES
    • update installation guidelines
    • add Getting Help Section
  • Review and update DESCRIPTION
    • 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 '
    • LICENSE file is not mentioned in License field and LICENSE is add to .Rbuildignore
  • Run urlchecker::url_check() to identify broken links and fix
  • Run R CMD check --as-cran make sure everything pass
  • You have checked the Package Release Template https://github.com/insightsengineering/teal.reporter/pull/205/files
  • Make sure all teal.* mentions are lower-cased and quoted
  • Make Sure inst/WORDLIST is minimalized
  • 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 exception in .lintr: indentation_linter = NULL
  • @noMd (in favor of Roxygen: list(markdown = TRUE) in DESCRIPTION)

@m7pr m7pr added the core label Feb 19, 2024
@m7pr m7pr mentioned this pull request Feb 19, 2024
26 tasks
@m7pr m7pr marked this pull request as ready for review February 19, 2024 14:24
@m7pr m7pr requested review from averissimo, kartikeyakirar and a team February 19, 2024 14:24
Copy link
Contributor

github-actions bot commented Feb 19, 2024

badge

Code Coverage Summary

Filename                      Stmts    Miss  Cover    Missing
--------------------------  -------  ------  -------  ------------------------------------
R/tm_a_pca.R                    827     827  0.00%    108-1068
R/tm_a_regression.R             776     776  0.00%    153-1033
R/tm_data_table.R               179     179  0.00%    93-325
R/tm_file_viewer.R              170     170  0.00%    44-248
R/tm_front_page.R               129     118  8.53%    70-222
R/tm_g_association.R            334     334  0.00%    135-541
R/tm_g_bivariate.R              671     411  38.75%   306-771, 812, 923, 940, 958, 969-991
R/tm_g_distribution.R          1042    1042  0.00%    122-1299
R/tm_g_response.R               350     350  0.00%    154-577
R/tm_g_scatterplot.R            726     726  0.00%    230-1057
R/tm_g_scatterplotmatrix.R      282     263  6.74%    165-476, 537, 551
R/tm_missing_data.R            1058    1058  0.00%    92-1304
R/tm_outliers.R                 988     988  0.00%    134-1265
R/tm_t_crosstable.R             255     255  0.00%    141-444
R/tm_variable_browser.R         825     820  0.61%    79-1064, 1102-1286
R/utils.R                        99      96  3.03%    82-267
R/zzz.R                           1       1  0.00%    2
TOTAL                          8712    8414  3.42%

Diff against main

Filename                      Stmts    Miss  Cover
--------------------------  -------  ------  --------
R/tm_a_pca.R                     +2      +2  +100.00%
R/tm_a_regression.R              -1      -1  +100.00%
R/tm_data_table.R                +2      +2  +100.00%
R/tm_file_viewer.R               -2      -2  +100.00%
R/tm_g_association.R             +2      +2  +100.00%
R/tm_g_bivariate.R               +6     -82  +12.88%
R/tm_g_distribution.R           +14     +14  +100.00%
R/tm_g_response.R                -1      -1  +100.00%
R/tm_g_scatterplot.R             +7      +7  +100.00%
R/tm_g_scatterplotmatrix.R       +2      +2  -0.05%
R/tm_missing_data.R              +4      +4  +100.00%
R/tm_outliers.R                 +11     +11  +100.00%
R/tm_t_crosstable.R              +1      +1  +100.00%
R/tm_variable_browser.R          +1      +1  -0.00%
R/utils.R                        -1      -4  +3.03%
TOTAL                           +47     -44  +1.03%

Results for commit: 92bdf31

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

Copy link
Contributor

github-actions bot commented Feb 19, 2024

Unit Tests Summary

 1 files   6 suites   0s ⏱️
29 tests 29 ✅ 0 💤 0 ❌
67 runs  67 ✅ 0 💤 0 ❌

Results for commit 92bdf31.

♻️ This comment has been updated with latest results.

R/tm_data_table.R Outdated Show resolved Hide resolved
R/tm_file_viewer.R Outdated Show resolved Hide resolved
m7pr and others added 5 commits February 20, 2024 10:26
Co-authored-by: kartikeya kirar <[email protected]>
Signed-off-by: Marcin <[email protected]>
Closes #642.

Removed `substitute_q` and `extract_input`.
Added `@keywords internal` to `is_num_var_short`.
Part of #624

From this
#624 (comment)

#### Changes description

- Adds `@return` tag to `shared_params` to be reused across all
documentation
- Corrects linter errors
@kartikeyakirar
Copy link
Contributor

Hey @m7pr, some some minor comments above. Apart from that, the PR looks good to go after #696.

averissimo and others added 4 commits March 1, 2024 10:50
# Pull Request

- Fixes #686
- Part of #624 

#### Changes descriptions

- Adds missing assertions described on #686 
- Adds a helper function called `assert_single_selection`
- Avoids many repetitive calls across functions to check for multiple
selections
  - Adds simple unit tests
- Adds some comments to maintain a consistent structure

---------

Signed-off-by: André Veríssimo <[email protected]>
Co-authored-by: Dawid Kałędkowski <[email protected]>
Co-authored-by: kartikeya kirar <[email protected]>
Signed-off-by: Marcin <[email protected]>
@m7pr
Copy link
Contributor Author

m7pr commented Mar 1, 2024

Thanks @kartikeyakirar for cleaning up the finish line! Everything is merged and lasts checks are running.
We just need to get an acceptance on this PR. Any last (famous) words :D?

Copy link
Contributor

github-actions bot commented Mar 1, 2024

Unit Test Performance Difference

Test Suite $Status$ Time on main $±Time$ $±Tests$ $±Skipped$ $±Failures$ $±Errors$
tm_g_bivariate 👶 $+0.25$ $+18$ $0$ $0$ $0$
Additional test case details
Test Suite $Status$ Time on main $±Time$ Test Case
tm_g_bivariate 👶 $+0.00$ tm_g_bivariate_creates_a_module_with_datanames_taken_from_data_extracts
tm_g_bivariate 👶 $+0.09$ tm_g_bivariate_creates_a_teal_module_object
tm_g_bivariate 👶 $+0.02$ tm_g_bivariate_creates_a_teal_module_object_with_default_options
tm_g_bivariate 👶 $+0.01$ tm_g_bivariate_creates_a_teal_module_object_with_multiple_data_extract_specs
tm_g_bivariate 👶 $+0.00$ tm_g_bivariate_determines_color_size_and_fill_when_color_setting_is_TRUE
tm_g_bivariate 👶 $+0.01$ tm_g_bivariate_fails_when_color_setting_is_FALSE_and_color_is_supplied
tm_g_bivariate 👶 $+0.01$ tm_g_bivariate_fails_when_color_setting_is_FALSE_and_fill_is_supplied
tm_g_bivariate 👶 $+0.01$ tm_g_bivariate_fails_when_color_setting_is_FALSE_and_size_is_supplied
tm_g_bivariate 👶 $+0.03$ tm_g_bivariate_fails_when_plot_height_is_not_valid
tm_g_bivariate 👶 $+0.03$ tm_g_bivariate_fails_when_plot_width_is_not_valid
tm_g_bivariate 👶 $+0.01$ tm_g_bivariate_fails_when_x_contains_a_spec_with_multiple_selection
tm_g_bivariate 👶 $+0.02$ tm_g_bivariate_fails_when_x_contains_multiple_spec_with_at_least_one_multiple_selection
tm_g_bivariate 👶 $+0.01$ tm_g_bivariate_fails_when_y_contains_multiple_spec_with_at_least_one_multiple_selection

Results for commit d7f056d

♻️ This comment has been updated with latest results.

DESCRIPTION Outdated Show resolved Hide resolved
Co-authored-by: André Veríssimo <[email protected]>
Signed-off-by: Marcin <[email protected]>
.github/workflows/release.yaml Outdated Show resolved Hide resolved
vignettes/teal-modules-general.Rmd Outdated Show resolved Hide resolved
DESCRIPTION Outdated Show resolved Hide resolved
Signed-off-by: Marcin <[email protected]>
@m7pr m7pr requested a review from averissimo March 1, 2024 10:22
@averissimo averissimo dismissed their stale review March 1, 2024 10:22

Corrected

Copy link
Contributor

@averissimo averissimo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

I went again through the initial bullet point list and it seems fine to merge!

.lintr Outdated Show resolved Hide resolved
@m7pr
Copy link
Contributor Author

m7pr commented Mar 1, 2024

Thanks @averissimo . I also did went again through the list, once you pointed some obvious mistakes!
Once #703 is merged, I'll merge this one.

#703)

# Pull Request

<!--- Replace `#nnn` with your issue link for reference. -->

- Part of #624
- Extends ANL rule to allow `ANL_OUTLIERS` and others variables that are
prefixed with `ANL_` (in all caps)
@averissimo
Copy link
Contributor

Fearless leader, we await the glorious merge 🐴 ⚔️

@m7pr m7pr merged commit 5c2fb78 into main Mar 1, 2024
26 checks passed
@m7pr m7pr deleted the pre-release@main branch March 1, 2024 12:12
@m7pr
Copy link
Contributor Author

m7pr commented Mar 1, 2024

veni, vidi, merge

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants