Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

MicrobiomeProfiler #2320

Closed mjchen1996 closed 3 years ago

mjchen1996 commented 3 years ago

Update the following URL to point to the GitHub repository of the package you wish to submit to Bioconductor

Confirm the following by editing each check box to '[x]'

I am familiar with the essential aspects of Bioconductor software management, including:

For questions/help about the submission process, including questions about the output of the automatic reports generated by the SPB (Single Package Builder), please use the #package-submission channel of our Community Slack. Follow the link on the home page of the Bioconductor website to sign up.

bioc-issue-bot commented 3 years ago

Hi @mjchen1996

Thanks for submitting your package. We are taking a quick look at it and you will hear back from us soon.

The DESCRIPTION file for this package is:

Package: MicrobiomeProfiler
Title: An shiny package for microbiome functional enrichment analysis
Version: 0.99.0
Authors@R: c(
    person(given = "Meijun",family = "Chen",role = c("aut", "cre"),email = "mjchen1996@outlook.com"),
    person(given = "Guangchuang", family = "Yu", email = "guangchuangyu@gmail.com", role  = c("aut", "ctb"), comment = c(ORCID = "0000-0002-6485-8781"))
    )
Description: This is an R/shiny package to perform functional enrichment analysis for microbiome data. 
   This package was based on clusterProfiler. Moreover, MicrobiomeProfiler support KEGG enrichment analysis,
   COG enrichment analysis, Microbe-Disease association enrichment analysis, Metabo-Pathway analysis.
License: GPL-2
URL: https://github.com/YuLab-SMU/MicrobiomeProfiler/
BugReports: https://github.com/YuLab-SMU/MicrobiomeProfiler/issues
Imports: 
    clusterProfiler (>= 4.0.2),
    config,
    DT,
    enrichplot,
    golem,
    magrittr,
    shiny (>= 1.6.0),
    shinyWidgets,
    shinycustomloader,
    htmltools,
    ggplot2,
    graphics,
    utils
Encoding: UTF-8
biocViews: Microbiome, Software, Visualization,KEGG
RoxygenNote: 7.1.2
Depends: 
    R (>= 4.1.0)
Suggests: 
    rmarkdown,
    knitr,
    testthat (>= 3.0.0)
Config/testthat/edition: 3
VignetteBuilder: knitr
bioc-issue-bot commented 3 years ago

A reviewer has been assigned to your package. Learn what to expect during the review process.

IMPORTANT: Please read this documentation for setting up remotes to push to git.bioconductor.org. It is required to push a version bump to git.bioconductor.org to trigger a new build.

Bioconductor utilized your github ssh-keys for git.bioconductor.org access. To manage keys and future access you may want to active your Bioconductor Git Credentials Account

bioc-issue-bot commented 3 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "ERROR". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/MicrobiomeProfiler to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: dc36a8435e468528df03ed3454823c41da812e7b

bioc-issue-bot commented 3 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "ERROR". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/MicrobiomeProfiler to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 81caf8dce5bb129681d7e15c6528ee64f13cc5c8

bioc-issue-bot commented 3 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "ERROR". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/MicrobiomeProfiler to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 39c6c9e5c59c230f39b710ab4b47ebc5904e0a74

bioc-issue-bot commented 3 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "ERROR". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/MicrobiomeProfiler to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 08e41f14534a4ed03907d3d5a37c17978f082a13

bioc-issue-bot commented 3 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

Congratulations! The package built without errors or warnings on all platforms.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/MicrobiomeProfiler to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

mjchen1996 commented 3 years ago

Hi, @lazappi , thank you for your assistance. I was just wondering if my package had under review queue?

lazappi commented 3 years ago

Hi @mjchen1996. As I'm sure you know it's super busy at the moment with everyone trying to get packages accepted for the upcoming release. I think yours is at the top of my list so hopefully not too long.

mjchen1996 commented 3 years ago

Thank you for your reply.

lazappi commented 3 years ago

Hi @mjchen1996

Thanks for submitting MicrobiomeProfiler :tada:! Below is my review of your package. Please reply here if anything is unclear or needs any further explanation.

What next?

Please address the comments as best as you can. When you are ready for me to check the package again please reply to let me know with a summary of changes you have made or any other responses.

Luke

Review

Key: :rotating_light: Required :warning: Recommended :green_circle: Optional

General package development

DESCRIPTION file

NAMESPACE file

Package data

README

Vignette

Man pages

Unit tests

Code

R

Additional files

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 8ab6cddf9d429644c7ff09b38fd9b8a58dfc9ab4

bioc-issue-bot commented 3 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

Congratulations! The package built without errors or warnings on all platforms.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/MicrobiomeProfiler to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

mjchen1996 commented 3 years ago

Hi @lazappi

Thank you for your assistance. Here is a summary of the changes.

General package development

DESCRIPTION file

Package data

Vignette

lazappi commented 3 years ago

Package data

  • [x] 🚨 The documentation for data included in the package is very minimal. Please expand this so it is clear what the data is, where it can from and what structure it has. Thank you. I have expanded the description of data and added reference URL.

I think you can probably still had some detail to this. The main thing is to add something about the data structure (is is a data.frame, a matrix, something else?).

  • [x] 🚨 There is an additional R/sysdata.rda data file. This should either be removed or moved to the data/ or inst/data directories. Sorry. The sydata.rda is required for the shiny app and enrichX() functions. I think it can not be removed or moved to the data/ directory.

I think it might be possible to do this another way but it seems like R/sysdata.rda is a standard file I wasn't aware of so it should be fine.

I have tried my best to check and fix these issues. I have added Introduction and Installation sections in the vignette. Also, I added an example of KEGG enrichment analysis demo in the vignette.

This looks much better. There are a few typos and some formatting things you might want to look at but I'm happy with this.

Unit tests

  • [x] ⚠️ The unit tests are quite minimal. It is hard to test the shiny app but you could write more tests for the exported functions.

Did you have a look at adding some more tests?

Code

R

  • [x] 🚨 In the enrichX() functions slots are accessed directly using @. Please use a getter/setter function if possible. I used slot() instead of @.

I had a bit of a look at it seems like there aren't proper getters for this class so slot() should be ok.

Thanks for your responses. I'm happy with most things now, they only things I think are left is whether you can add a few more tests and adding some information about the data structures for the included data.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 3cd387c4e291e195851dd10824cdd2f57ac09b16

bioc-issue-bot commented 3 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "ERROR, skipped". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/MicrobiomeProfiler to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: abde2b59b36d1d3d98bb7f2ec9a9824323cb5056

bioc-issue-bot commented 3 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

Congratulations! The package built without errors or warnings on all platforms.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/MicrobiomeProfiler to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

mjchen1996 commented 3 years ago

Hi, @lazappi

Thank you for your reply.

I have added some new tests in my package. I think it is enough for exported functions since I have checked the S4 class results. As your known, it is hard to test the shiny app. Also, I have added data structure description as all example data are vectors. For R/sysdata.rda, this file included several data frame of annotation data collected from public databases like KEGG. Moreover. I had a bit of a look at vignette file and made some changes.

Meijun

lazappi commented 3 years ago

Hi @mjchen1996.

Thank you for adding information about the data structure but I think it would be clear to use the @format tag, please see the examples in this guide https://r-pkgs.org/data.html. Sorry, I should have been more specific about this earlier. The testing is ok now but I think you could continue to expand it, particularly for things like incorrect inputs.

I will approve this once you have adjusted the data documentation.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: f7c029e9a41005eaeefd2a71581ef3e573d38a13

bioc-issue-bot commented 3 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "ERROR". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/MicrobiomeProfiler to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: f88cd81d7dfc9d0a5ca98b96e2798e139b8958a5

bioc-issue-bot commented 3 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

Congratulations! The package built without errors or warnings on all platforms.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/MicrobiomeProfiler to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

mjchen1996 commented 3 years ago

Hi, @lazappi

Thank you again. I have adjusted the data documentation and added more test for incorrect inputs.

Meijun

lazappi commented 3 years ago

Thanks! I will approve this now πŸŽ‰. It can take a few days for the package to be picked up by the build system but it should be on Bioconductor soon.

bioc-issue-bot commented 3 years ago

Your package has been accepted. It will be added to the Bioconductor nightly builds.

Thank you for contributing to Bioconductor!

Reviewers for Bioconductor packages are volunteers from the Bioconductor community. If you are interested in becoming a Bioconductor package reviewer, please see Reviewers Expectations.

lshep commented 3 years ago

The master branch of your GitHub repository has been added to Bioconductor's git repository.

To use the git.bioconductor.org repository, we need an 'ssh' key to associate with your github user name. If your GitHub account already has ssh public keys (https://github.com/mjchen1996.keys is not empty), then no further steps are required. Otherwise, do the following:

  1. Add an SSH key to your github account
  2. Submit your SSH key to Bioconductor

See further instructions at

https://bioconductor.org/developers/how-to/git/

for working with this repository. See especially

https://bioconductor.org/developers/how-to/git/new-package-workflow/ https://bioconductor.org/developers/how-to/git/sync-existing-repositories/

to keep your GitHub and Bioconductor repositories in sync.

Your package will be included in the next nigthly 'devel' build (check-out from git at about 6 pm Eastern; build completion around 2pm Eastern the next day) at

https://bioconductor.org/checkResults/

(Builds sometimes fail, so ensure that the date stamps on the main landing page are consistent with the addition of your package). Once the package builds successfully, you package will be available for download in the 'Devel' version of Bioconductor using BiocManager::install("MicrobiomeProfiler"). The package 'landing page' will be created at

https://bioconductor.org/packages/MicrobiomeProfiler

If you have any questions, please contact the bioc-devel mailing list (https://stat.ethz.ch/mailman/listinfo/bioc-devel); this issue will not be monitored further.