Skip to content

Add BVBRC statistics R Markdown document#13

Merged
eboyer221 merged 13 commits into
mainfrom
BVBRC_stats
Jun 2, 2026
Merged

Add BVBRC statistics R Markdown document#13
eboyer221 merged 13 commits into
mainfrom
BVBRC_stats

Conversation

@AbhirupaGhosh
Copy link
Copy Markdown
Contributor

Description

What kind of change(s) are included?

  • Feature (adds or updates new capabilities)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have searched for existing content to ensure this is not a duplicate.
  • I have performed a self-review of these additions (including spelling, grammar, and related).
  • I have added comments to my code to help provide understanding.
  • I have added a test which covers the code changes found within this PR.
  • I have deleted all non-relevant text in this pull request template.
  • Reviewer assignment: Tag a relevant team member to review and approve the changes.

Copy link
Copy Markdown
Member

@jananiravi jananiravi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 jananiravi requested a review from eboyer221 April 13, 2026 20:43
Copy link
Copy Markdown
Member

@jananiravi jananiravi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needs annotation (text around code chunks)

Copy link
Copy Markdown
Contributor

@eboyer221 eboyer221 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Comment thread doc/BVBRC_stats.Rmd Outdated
Comment thread vignettes/BVBRC_stats.Rmd
Comment thread doc/BVBRC_stats.Rmd Outdated
Comment thread doc/BVBRC_stats.Rmd Outdated
Comment thread doc/BVBRC_stats.Rmd Outdated
Comment thread doc/BVBRC_stats.Rmd Outdated
Comment thread doc/BVBRC_stats.Rmd Outdated
Comment thread doc/BVBRC_stats.Rmd Outdated
Comment thread doc/BVBRC_stats.Rmd Outdated
@AbhirupaGhosh AbhirupaGhosh requested a review from eboyer221 May 29, 2026 22:20
@eboyer221
Copy link
Copy Markdown
Contributor

eboyer221 commented Jun 2, 2026

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.

Copy link
Copy Markdown
Contributor Author

@AbhirupaGhosh AbhirupaGhosh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The blocks are helpful. Thanks.
@eboyer221, please merge this if there is no other issue.

@eboyer221 eboyer221 merged commit b232d20 into main Jun 2, 2026
@eboyer221 eboyer221 deleted the BVBRC_stats branch June 2, 2026 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants