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

Add cheatsheet and more videos to README #837

Merged
merged 5 commits into from
Mar 7, 2024
Merged

Conversation

edelarua
Copy link
Contributor

@edelarua edelarua commented Mar 6, 2024

Closes #834

@edelarua
Copy link
Contributor Author

edelarua commented Mar 6, 2024

@Melkiades which 2 videos are you referencing here (#834 (comment))?

Copy link
Contributor

github-actions bot commented Mar 6, 2024

badge

Code Coverage Summary

Filename                     Stmts    Miss  Cover    Missing
-------------------------  -------  ------  -------  -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
R/00tabletrees.R               745      62  91.68%   21, 102, 105, 412, 496-497, 500, 656, 757, 849-850, 951, 953-954, 977-980, 1002, 1114-1117, 1212-1217, 1365, 1462-1465, 1529-1532, 1568-1571, 1577-1582, 1632, 1639, 1739, 1855, 1869, 1872-1875, 1878-1881, 1909, 1940-1941
R/as_html.R                    161      25  84.47%   5-10, 73, 130-135, 140-145, 160-164, 252
R/colby_constructors.R         560      20  96.43%   71, 123, 181-184, 244-247, 386, 403, 1209, 1301, 1463, 1501, 1523, 1547, 1568, 1722
R/compare_rtables.R             83      17  79.52%   92-95, 98-101, 114-117, 136, 156-157, 188, 193
R/format_rcell.R                12       0  100.00%
R/indent.R                      13       2  84.62%   39-40
R/index_footnotes.R             66       0  100.00%
R/make_split_fun.R             119      23  80.67%   22-25, 51-54, 57-60, 115, 119, 279, 282-285, 290-293, 312, 411
R/make_subset_expr.R           136      14  89.71%   34-48, 126-133, 168, 250, 266, 274
R/simple_analysis.R              5       1  80.00%   55
R/split_funs.R                 505      66  86.93%   143, 148, 154-159, 164, 181-185, 365-370, 387-392, 473, 525, 543-546, 563, 630, 640-641, 643, 657, 701, 726, 902, 909, 935-938, 949-950, 952, 954, 1124-1126, 1140-1144, 1208-1211, 1274-1277
R/summary.R                    215      24  88.84%   38, 84, 191, 199, 269-274, 285-286, 305-306, 416, 463-479, 514, 547
R/tree_accessors.R             946     102  89.22%   109, 251, 269, 292, 330, 344, 360, 465, 492-493, 774-779, 907, 925, 949, 999, 1054-1055, 1094, 1127, 1163-1167, 1223, 1298-1302, 1320-1330, 1399, 1504-1507, 1532, 1552-1553, 1562, 1603, 1621-1625, 1646-1650, 1729, 1771, 1875, 1979, 1992, 2005, 2019, 2027, 2036-2040, 2382, 2740, 2853, 2886-2908, 2997-3004, 3159, 3232-3237, 3445-3446, 3453, 3456-3459, 3463, 3510, 3570, 3595-3619
R/tt_afun_utils.R              411      32  92.21%   50, 164, 171, 181-194, 260, 271-272, 503, 511-514, 596-600, 621, 636-638
R/tt_compare_tables.R           70       4  94.29%   56, 178, 257, 261
R/tt_compatibility.R           510      56  89.02%   18, 141-142, 190, 195, 329-330, 334-337, 343, 347, 395, 517, 565, 598, 618, 651-654, 697, 714-718, 805, 833-836, 845, 908, 916, 927-930, 1040, 1047, 1076-1090, 1121-1122
R/tt_dotabulation.R           1124      96  91.46%   54, 252, 257, 259, 310, 334, 338-341, 373-376, 399, 434-437, 465-468, 564, 701-705, 755, 759, 788-791, 801, 821-825, 832-835, 1096, 1100, 1131, 1242-1245, 1450-1458, 1599, 1683-1692, 1772-1775, 1786, 1791, 1796-1797, 1799, 1810, 1815, 1838, 1932-1951
R/tt_export.R                  513      31  93.96%   44, 180-184, 232-235, 287-290, 435, 441, 473, 527, 818, 827, 852-856, 1023-1026, 1029, 1060, 1066
R/tt_from_df.R                  15       0  100.00%
R/tt_paginate.R                440      37  91.59%   45, 70, 107-115, 396, 518-521, 541-545, 694-697, 747-754, 823, 826, 836, 843, 846
R/tt_pos_and_access.R          571      43  92.47%   77, 79-81, 106, 165, 211-215, 260, 513, 515, 523, 529, 543, 553-556, 738, 749-753, 758-761, 788, 841-842, 854, 1020-1021, 1079-1107, 1387, 1464
R/tt_showmethods.R             144      21  85.42%   60, 97-120, 183, 209, 218, 226, 229-233, 326-327
R/tt_sort.R                     98       5  94.90%   261-264, 272
R/tt_toString.R                387      27  93.02%   119, 323-326, 332, 347, 357, 364, 367, 373-383, 471, 536, 542, 776-802
R/utils.R                       29       0  100.00%
R/validate_table_struct.R       84      10  88.10%   79-83, 92-93, 140, 150-151
R/Viewer.R                      61       9  85.25%   46, 50, 60-64, 84, 118
TOTAL                         8023     727  90.94%

Diff against main

Filename                     Stmts    Miss  Cover
-------------------------  -------  ------  --------
R/00tabletrees.R              +121     +21  -1.75%
R/as_html.R                    +73     +18  -7.57%
R/colby_constructors.R         +78      +3  -0.04%
R/compare_rtables.R             +5      +6  -6.38%
R/index_footnotes.R            +16       0  +100.00%
R/make_split_fun.R            +119     +23  +80.67%
R/make_subset_expr.R           +30      +2  +1.03%
R/split_funs.R                 +84     +11  -0.01%
R/summary.R                    +32      +8  -2.42%
R/tree_accessors.R            +153     +34  -2.21%
R/tt_afun_utils.R              +66      +7  -0.54%
R/tt_compare_tables.R           +5       0  +0.44%
R/tt_compatibility.R           +97      +6  +1.13%
R/tt_dotabulation.R           +387     +52  -2.57%
R/tt_export.R                 +284     -42  +25.83%
R/tt_from_df.R                  +6       0  +100.00%
R/tt_paginate.R                +57     +22  -4.49%
R/tt_pos_and_access.R          +51      +6  -0.42%
R/tt_showmethods.R             +23       0  +2.77%
R/tt_sort.R                    +17      -1  +2.31%
R/tt_toString.R                +82      +5  +0.24%
R/utils.R                      +18      -1  +9.09%
R/validate_table_struct.R      +84     +10  +88.10%
R/Viewer.R                      +5       0  +1.32%
TOTAL                        +1893    +190  -0.30%

Results for commit: 0cd2564

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

Copy link
Contributor

github-actions bot commented Mar 6, 2024

Unit Tests Summary

    1 files     24 suites   1m 39s ⏱️
  202 tests   202 ✅ 0 💤 0 ❌
1 529 runs  1 529 ✅ 0 💤 0 ❌

Results for commit 0cd2564.

♻️ This comment has been updated with latest results.

README.md Show resolved Hide resolved
Copy link
Contributor

@Melkiades Melkiades left a comment

Choose a reason for hiding this comment

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

I thought about it and I think we may want to add it to the top bar or do you think it is too crowded?

Regarding the second half of the issue, there are a couple of videos from Gabe and me that are not present in the readme and I think it could be useful to add them. When you are online I can add them or send them to you ;)

https://www.youtube.com/watch?v=sxFsavKI7s4
https://www.youtube.com/watch?v=zBm_NZ0VtKs (this to add to the slides)
https://www.youtube.com/watch?v=1i6vOId2h4A (this is new to me)

https://www.youtube.com/watch?v=YPmbLPSYFYM (our demo that should go here but also on tern/TLG-c/falcon maybe? I would add the slides too)
https://www.youtube.com/watch?v=yZS4OBuJe_Q (this is the UseR! conference that should be very visible imo bc there are also other people and the discussion seemed very interesting to me)

Maybe @telepath37 you know better where to place the videos and slides. Should they be on the documentation? on the website?

ps: this should also be more present in general: https://rconsortium.github.io/rtrs-wg/tablepkgs.html#rtables

Copy link
Contributor

@ayogasekaram ayogasekaram left a comment

Choose a reason for hiding this comment

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

lgtm!

@edelarua edelarua changed the title Add cheatsheet to README Add cheatsheet and more videos to README Mar 7, 2024
Copy link
Contributor

github-actions bot commented Mar 7, 2024

Unit Test Performance Difference

Test Suite $Status$ Time on main $±Time$ $±Tests$ $±Skipped$ $±Failures$ $±Errors$
Exporters 💔 $18.89$ $+1.00$ $0$ $0$ $0$ $0$

Results for commit 635054e

♻️ This comment has been updated with latest results.

@edelarua edelarua merged commit 7fe8752 into main Mar 7, 2024
25 checks passed
@edelarua edelarua deleted the 834_cs_to_readme@main branch March 7, 2024 22:50
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.

Updated README/intro with cheatsheet and more video/slides
3 participants