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

Update QC report tables #371

Open
sjspielman opened this issue Jul 6, 2023 · 4 comments
Open

Update QC report tables #371

sjspielman opened this issue Jul 6, 2023 · 4 comments
Labels
nice to have QC Relevant to the HTML QC report made available to users

Comments

@sjspielman
Copy link
Member

From this comment

Oh, one more comment, which I don't want to make hold this up: When we have a lot of ADTs, this table gets kind of unreasonably long. We could limit this to a set number of ADTs, or collapse the table, but I'm not really sure what the best option is here. Maybe a JS table like https://glin.github.io/reactable/ ?

We should take some time to revisit tables overall, including but not limited to excessively long tables. Another lightweight (aka no additional dependencies) approach could be DT::datatable(), but we should probably explore a couple options.

@sjspielman
Copy link
Member Author

Another table update we could use, from #483 (comment):

If we are reusing this style frequently across different table types, it might make sense as a separate function that we define at the top and reuse as needed. (I think we duplicate this a lot)

We reuse a lot of kable formatting so we might benefit from a function to handle a lot of that.

@sjspielman sjspielman added QC Relevant to the HTML QC report made available to users nice to have labels Nov 6, 2023
@sjspielman
Copy link
Member Author

reactable might give us files that are too big, if react.js is coming along for the ride! Something to keep our 👀 on if we go that direction.

@sjspielman
Copy link
Member Author

sjspielman commented Nov 21, 2023

I played around a little here with a real QC report to see how using reactable tables might influence overall file size. Turns out it's not so simple, but I don't really understand why..!

For the main report, the HTML is slightly, but only slightly, smaller with reactable.
But, for the cell type report, the HTML is substantially larger.

I tripled checked all this to make sure I wasn't confusing which file was which, too. 🤷‍♀️

Downloads ➤ ls -lh                                                                                              
total 15M
-rw-r--r-- 1 sjspielman staff 2.7M Nov 21 10:03 celltypes_supplemental_report-kable.html
-rw-r--r-- 1 sjspielman staff 3.1M Nov 21 10:03 celltypes_supplemental_report-reactable.html
-rw-r--r-- 1 sjspielman staff 4.3M Nov 21 09:57 main_qc_report-kable.html
-rw-r--r-- 1 sjspielman staff 4.3M Nov 21 10:14 main_qc_report-reactable.html
Downloads ➤ ls -l                                                                                               
total 14536
-rw-r--r-- 1 sjspielman staff 2776782 Nov 21 10:03 celltypes_supplemental_report-kable.html
-rw-r--r-- 1 sjspielman staff 3225664 Nov 21 10:03 celltypes_supplemental_report-reactable.html
-rw-r--r-- 1 sjspielman staff 4443659 Nov 21 09:57 main_qc_report-kable.html
-rw-r--r-- 1 sjspielman staff 4434540 Nov 21 10:14 main_qc_report-reactable.html

Edit - here's the files all zipped up for reference. reports.zip

@sjspielman
Copy link
Member Author

Noting that DT has a somewhat uncertain future with a new maintainer incoming, it seems -

https://yihui.org/en/2024/01/bye-rstudio/

So please do not panic—our existing R packages will still be maintained. The only exception is the DT package, which is not included in the contract, and Posit plans to find a new maintainer for it. Before that happens, I might still be able to help (time permitting), but I cannot promise.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
nice to have QC Relevant to the HTML QC report made available to users
Projects
None yet
Development

No branches or pull requests

1 participant