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

335 bring teal_slice(s) to package index and create separate man pages for teal_slice(s) utilities #572

Merged
merged 6 commits into from
Mar 21, 2024

Conversation

m7pr
Copy link
Contributor

@m7pr m7pr commented Mar 18, 2024

Closes #335

  • Created separate documentation page for teal_slice-utilities
    • included is.teal_slice, as.teal_slice, as.list.teal_slice, print.teal_slice, format.teal_slice
    • inheriting params from teal_slice
    • inheriting examples from teal_slice
    • man page contains @keywords internal so does not appear in package index
  • teal_slice man page
    • extended @seealso section to point to utility functions
    • utility functions mentioned in the @description of the page
    • utilities visible in examples

Did the same for teal_slices and respective utility functions.

Utility functions are not visible in package index, where teal_slice and teal_slices were brought back to package index

image

@m7pr m7pr added the core label Mar 18, 2024
@m7pr m7pr marked this pull request as ready for review March 18, 2024 09:47
@m7pr m7pr requested a review from a team March 18, 2024 09:47
Copy link
Contributor

github-actions bot commented Mar 18, 2024

badge

Code Coverage Summary

Filename                        Stmts    Miss  Cover    Missing
----------------------------  -------  ------  -------  ------------------------------------------------------------------------------------------------------------------------------------------------------
R/calls_combine_by.R                7       0  100.00%
R/choices_labeled.R                49      14  71.43%   25, 36, 41, 51-56, 68, 72-76
R/count_labels.R                   97       0  100.00%
R/filter_panel_api.R               29       1  96.55%   132
R/FilteredData-utils.R             68      25  63.24%   21-24, 27-30, 52-57, 153, 175-184
R/FilteredData.R                  562     227  59.61%   110, 184, 326, 398, 501-510, 533, 554-595, 613-616, 632, 673-706, 721-723, 727-733, 762-790, 813-815, 819-821, 824-838, 842-852, 855-898, 939, 962-984
R/FilteredDataset-utils.R          23       1  95.65%   125
R/FilteredDataset.R               170      61  64.12%   52, 152, 191, 216-273, 312-314
R/FilteredDatasetDataframe.R      121       8  93.39%   87, 148, 158, 234-238
R/FilteredDatasetDefault.R         18       4  77.78%   103-116
R/FilteredDatasetMAE.R            134      37  72.39%   56, 117-122, 161-166, 170-171, 189-211
R/FilterPanelAPI.R                 10       0  100.00%
R/FilterState-utils.R             101       2  98.02%   264, 294
R/FilterState.R                   361      61  83.10%   89, 212, 230-234, 241-242, 256-257, 263-264, 311, 313, 315, 367, 411, 639, 682-705, 715-734, 769-775, 784-790
R/FilterStateChoices.R            341     108  68.33%   310-313, 325, 367, 389-396, 400-417, 445, 458-469, 481-489, 493-522, 543-546, 549-552, 563-586, 597, 602, 613
R/FilterStateDate.R               212     129  39.15%   227, 279-436
R/FilterStateDatettime.R          309     199  35.60%   266, 318-549
R/FilterStateEmpty.R               53      31  41.51%   89, 99-104, 117, 129-169
R/FilterStateExpr.R                75      62  17.33%   149-272
R/FilterStateLogical.R            196     144  26.53%   136, 158, 218, 222-406
R/FilterStateRange.R              408     105  74.26%   262, 384, 510-514, 517-527, 530, 542-548, 559-571, 575-585, 589-591, 605-632, 647, 650, 664-681, 716-721, 731-733
R/FilterStates-utils.R             70       9  87.14%   108, 127, 188-194, 216, 245
R/FilterStates.R                  364      30  91.76%   78-82, 191, 314-323, 411-414, 457, 542-546, 591, 712-715
R/FilterStatesDF.R                  5       0  100.00%
R/FilterStatesMAE.R                10       1  90.00%   40
R/FilterStatesMatrix.R              3       0  100.00%
R/FilterStatesSE.R                211     157  25.59%   36, 71-73, 83-85, 109-116, 124-131, 154-302
R/include_css_js.R                  5       5  0.00%    12-16
R/teal_slice.R                    107       4  96.26%   131, 195-196, 206
R/teal_slices.R                    84       5  94.05%   150-155
R/test_utils.R                     21       0  100.00%
R/utils.R                          18       0  100.00%
R/variable_types.R                 15       8  46.67%   44-51
R/zzz.R                            17      17  0.00%    3-47
TOTAL                            4274    1455  65.96%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: fcf1166

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

Copy link
Contributor

github-actions bot commented Mar 18, 2024

Unit Tests Summary

  1 files   29 suites   23s ⏱️
359 tests 359 ✅ 0 💤 0 ❌
824 runs  824 ✅ 0 💤 0 ❌

Results for commit fcf1166.

♻️ This comment has been updated with latest results.

@m7pr
Copy link
Contributor Author

m7pr commented Mar 18, 2024

I see some R CMD CHECK failures

Missing link or links in documentation object 'teal_slices.Rd':c.teal_sliceSee section 'Cross-references' in the 'Writing R Extensions' manual.
* checking for missing documentation entries ... OK
* checking for code/documentation mismatches ... OK
* checking Rd \usage sections ... WARNING
Documented arguments not in \usage in documentation object 'teal_slice':x’ ‘show_all’ ‘trim_linesDocumented arguments not in \usage in documentation object 'teal_slices':x’ ‘i’ ‘recursive

@m7pr
Copy link
Contributor Author

m7pr commented Mar 18, 2024

R CMD CHECK fixed

@donyunardi donyunardi self-assigned this Mar 19, 2024
Copy link
Contributor

@donyunardi donyunardi left a comment

Choose a reason for hiding this comment

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

LGTM!
Please add entry to NEWS.md since this is user facing info.

@m7pr m7pr enabled auto-merge (squash) March 21, 2024 09:17
@m7pr m7pr merged commit 0bdd187 into main Mar 21, 2024
23 checks passed
@m7pr m7pr deleted the 335_docs_for_utilities@main branch March 21, 2024 09:17
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.

teal_slice should show up in package index
2 participants