insightsengineering / tlg-catalog

A catalog of Tables, Listings and Graphs (TLGs) created with NEST R packages
https://insightsengineering.github.io/tlg-catalog/
Other
20 stars 8 forks source link

Readme #212

Closed pawelru closed 8 months ago

pawelru commented 9 months ago

Let me summon

@telepath37 @khatril @lcd2yyz for awareness - this aims to lower the entry bar to sell this more efficiently to our end user base and beyond. Feel free to give feedback. You might find it easier to see from GH preview (as opposed to PR changes): https://github.com/insightsengineering/tlg-catalog/tree/readme

@cicdguy asking for overall review @vedhav (only if you have bandwidth) - asking for review of package/README.md file. You were somewhat included in the prior discussion and I ask you to check if the instructions are correct and clear. And maybe @chlebowa (only if you have bandwidth) - for review of package/README.md in particular. I assume you were not yet included in the prior discussion and I want you to check whether the instructions are clear from the perspective of the new developer. For both of you, the expectation is a ~basic~ actually one level more than basic awareness of what's happening - not necessarily complete understanding. This is not meant to be complete manual - just a README file.

Closes https://github.com/insightsengineering/tlg-catalog/issues/111

github-actions[bot] commented 9 months ago

Unit Tests Summary

  1 files  2 suites   58s :stopwatch:  24 tests 0 :white_check_mark:  24 :zzz: 0 :x: 289 runs  0 :white_check_mark: 289 :zzz: 0 :x:

Results for commit e7084a7b.

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

github-actions[bot] commented 9 months ago

Unit Test Performance Difference

Test Suite $Status$ Time on main $±Time$ $±Tests$ $±Skipped$ $±Failures$ $±Errors$
graph-snaps 💔 $7.72$ $+1.93$ $0$ $0$ $0$ $0$
Additional test case details | Test Suite | $Status$ | Time on `main` | $±Time$ | Test Case | |:-----|:----:|:----:|:----:|:-----| | graph-snaps | 💔 | $3.45$ | $+1.26$ | plot_v1 |

Results for commit b3612be80cc1ab0d6be33f411fd2086d1c5943a8

♻️ This comment has been updated with latest results.

chlebowa commented 9 months ago

Sorry for the string of single comments, I meant to group them together but clicked the wrong button. I have no more at the moment.

pawelru commented 8 months ago

Thanks @chlebowa for awesome review! Appreciate it!