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).
| ```{r setup, include=FALSE} | ||
| library(tidyverse) | ||
|
|
||
| bvbrc <- read.table("bvbrc_data.tsv", sep = "\t", header = TRUE, fill = TRUE, |
There was a problem hiding this comment.
where is this file , 'bvbrc_data.tsv', coming from? does the user export it from BV-BRC? Right now I don't think the Rmd will work for anyone without that file.
| ) | ||
| ``` | ||
|
|
||
| ```{r functions} |
There was a problem hiding this comment.
Each of these code chunks needs a paragraph saying what it computes and why. Need to add a paragraph before this functions chunk, before stats (line 84), and before each of the four output chunks (lines 134-145).
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.