Add BVBRC statistics R Markdown document#13
Conversation
jananiravi
left a comment
There was a problem hiding this comment.
needs the following to serve as a vignette
- to reside in
vignettes/ - call specific tidyverse packages (bioc requirement)
- check path for bvbrc_data.tsv & bvbrc vs. bvbrc_clean
- use of named r chunks
- text description between chunks
- missing YAML
- documentation
cc: @AbhirupaGhosh @eboyer221
jananiravi
left a comment
There was a problem hiding this comment.
needs annotation (text around code chunks)
eboyer221
left a comment
There was a problem hiding this comment.
Suggested code changes to format the vignette shown in review.
Additional comment : The Rmd should live at vignettes/BVBRC_stats.Rmd rather than doc/ (R packages auto-generated doc/ from vignettes/ at build time).
Refactor R Markdown to improve code readability and structure. Update functions for fetching and cleaning BVBRC metadata.
|
I just pushed a small follow-up that handles a few of the earlier asks: moved the Rmd from doc/ to vignettes/, added a ## heading + short paragraph before each chunk explaining what it computes, and fixed the output chunks at the bottom that had six-backtick fences (they wouldn't have knit correctly as-is). I am approving based on my review - but you may want to double-check the short paragraphs I added before each chunk @AbhirupaGhosh @jananiravi to make sure they look accurate. |
There was a problem hiding this comment.
The blocks are helpful. Thanks.
@eboyer221, please merge this if there is no other issue.
Description
What kind of change(s) are included?
Checklist
Please ensure that all boxes are checked before indicating that this pull request is ready for review.