Create rlistings cheatsheet

insightsengineering / rlistings

Value formatting and ASCII rendering infrastructure for tables and listings.

https://insightsengineering.github.io/rlistings/

24 stars 5 forks source link

Create rlistings cheatsheet #200

Closed edelarua closed 7 months ago

edelarua commented 7 months ago

Closes #190

github-actions[bot] commented 7 months ago

Code Coverage Summary

Filename                 Stmts    Miss  Cover    Missing
---------------------  -------  ------  -------  ----------------------------------------------------
R/paginate_listing.R        47       1  97.87%   101
R/rlistings_methods.R      101      14  86.14%   39, 54, 58, 140-143, 146, 230-236
R/rlistings.R              166      25  84.94%   158-161, 164-167, 206-210, 377-380, 384-387, 420-423
TOTAL                      314      40  87.26%

Diff against main

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

Results for commit: f47c1d88243db8080e82f872213fe7720f635b71

Minimum allowed coverage is 80%

:recycle: This comment has been updated with latest results

github-actions[bot] commented 7 months ago

Unit Tests Summary

1 files 4 suites 5s :stopwatch: 34 tests 27 :white_check_mark: 7 :zzz: 0 :x: 86 runs 75 :white_check_mark: 11 :zzz: 0 :x:

Results for commit f47c1d88.

:recycle: This comment has been updated with latest results.

shajoezhu commented 7 months ago

hi @edelarua , this looks really great! Thanks for making a first stab, i was wondering if we should try and use the same example, so it is eaiser for referencing.

edelarua commented 7 months ago

Great job Emily!!!! I am wondering if we could add also the ref footnote vignette (it is a workaround ofc) in the decoration part. What do you think?

Since we don't explicitly support ref footnotes (i.e. no functions in rlistings to create these) I thought it might be best not to include it on the cheatsheet, or just to include a link the vignette article on ref footnotes. What are your thoughts?

Melkiades commented 7 months ago

Great job Emily!!!! I am wondering if we could add also the ref footnote vignette (it is a workaround ofc) in the decoration part. What do you think?

Since we don't explicitly support ref footnotes (i.e. no functions in rlistings to create these) I thought it might be best not to include it on the cheatsheet, or just to include a link the vignette article on ref footnotes. What are your thoughts?

It makes sense, I just wanted to have it for completeness, but it is ok w/o too

shajoezhu commented 7 months ago

add news

KlaudiaBB commented 7 months ago

Great job Emily!!!! I am wondering if we could add also the ref footnote vignette (it is a workaround ofc) in the decoration part. What do you think?

@KlaudiaBB we need to advertise this and {rtables} one asap ;)

This week we are meeting with POs to discuss release comms, I will mention this topic if time permits