Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

ggmsa #2318

Closed nyzhoulang closed 2 years ago

nyzhoulang 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 @nyzhoulang

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: ggmsa
Title: Plot Multiple Sequence Alignment using 'ggplot2'
Version: 0.99.0
Authors@R: c(person("Lang", "Zhou",      email = "nyzhoulang@gmail.com",    role = c("aut", "cre")),
   person("Guangchuang", "Yu", email = "guangchuangyu@gmail.com", role = c("aut", "ths"), comment = c(ORCID = "0000-0002-6485-8781")),
   person("Shuangbin", "Xu",   email = "xshuangbin@163.com",      role = "ctb"),
   person("Huina", "Huang",    email = "1185796994@qq.com",       role = "ctb"))
Description:  A visual exploration tool for multiple sequence alignment and associated data. 
    Supports MSA of DNA, RNA, and protein sequences using 'ggplot2'. 
    Multiple sequence alignment can easily be combined with other 'ggplot2' plots, 
    such as phylogenetic tree produced by 'ggtree', boxplot, genome map and so on. 
    More features:visualization of sequence logos, sequence bundles, RNA secondary structures and detection of sequence recombinations.
Depends: R (>= 4.1.0)
Imports:
    Biostrings,
    ggplot2,
    magrittr,
    tidyr,
    utils,
      stats,
      stringr,
      aplot,
      RColorBrewer,
      ggalt,
      ggforce,
      methods,
      dplyr,
      R4RNA,
      grDevices,
      grid
Suggests:
    ggtreeExtra,
    ggtree (>= 1.17.1),
    ape,
    cowplot,
    knitr,
    prettydoc,
    rmarkdown,
    seqmagick,
    readxl,
    ggnewscale,
    kableExtra,
    gggenes
License: Artistic-2.0
Encoding: UTF-8
biocViews: Software, Visualization, Alignment, Annotation,MultipleSequenceAlignment
RoxygenNote: 7.1.1
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.

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/ggmsa to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

jianhong commented 2 years ago

Package ggmsa

The package is in pretty good shape. There are some minor issues need to be addressed.

General package development

The DESCRIPTION file

The NEWS file

Package data

Documentation

Unit tests

R code

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 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/ggmsa to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

jianhong commented 2 years ago

Could you please answer the review line by line to speed up the process when you are ready.

nyzhoulang commented 2 years ago

Dear Jianhong,

Thanks for the reminder. Actually, I have only completed part of the review at present.

I will report them in the above manner when I am fully prepared.

Could you please answer the review line by line to speed up the process when you are ready.

Kind regards, Lang

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 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/ggmsa to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 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/ggmsa to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

nyzhoulang commented 2 years ago

Dear Jianhong, Here is a summary of the changes. Thank you!

Cannot determine whether maintainer is subscribed to the bioc-devel mailing list (requires admin credentials). Subscribe here: https://stat.ethz.ch/mailman/listinfo/bioc-devel

Done. I am sure that I subscribed to the bioc-devel mailing list.

Please include Bioconductor installation instructions using BiocManager in README file.

Yes, added.

Please try to keep to an 80 character limit as Description field will otherwise be difficult to read when displayed online. A package URL and BugReports field is encouraged although not required

Done.

The version in News file Does not fit the submission.

Done, fixed the version number in News file.

Raw data in inst/extdata/ need documentation. sysdata in R folder may need documentation if the source is available.

Yes, I added documentation for all raw data in inst/extdata/

Vignette using BiocStyle package for formatting is suggested. Please include Bioconductor installation instructions using BiocManager. Please include sessionInfo() in vignette.

Done

Multiple rmd files are in vignettes/guides directory but not build.

Done. I removed all rmd files from vignettes/guides and build them on my gh-pages branch individually.

The VignetteIndexEntry are same for all the Rmd files.

Done, VignetteIndexEntry have be renamed.

Function arguments should be tested for validity, eg tidymsa in mas_data, msa in ggmsa.

Done. (in tests/testthat)

CONDUCT.md is not required for vignettes. Please move it to proper path.

Done.

Please try to keep to an 80 character limit as the code will otherwise be difficult to read when displayed online.

Done.

Package name and the main function name are same. The help page does not contain the help information for the package.

It seems difficult to rename as they were determined at the beginning of the design.

Consider adding unit tests. We strongly encourage them. See http://bioconductor.org/developers/how-to/unitTesting-guidelines/.

Done, unit tests added for msa in tidy_data, tidymsa in mas_data and msa in ggmsa by the thattest package.

message(), warning, stop instead of cat. Please try to keep to an 80 character limit as the code will otherwise be difficult to read when displayed online. clean up unused code. :: is not suggested in R code.

Done, Now it is improved and clear. (only base::strsplit was remained to prevent function collisions)

jianhong commented 2 years ago

Please double check the email you used in the authors list is subscribed to the bioc-devel mailing list. Others look great to me.

nyzhoulang commented 2 years ago

Thanks, jianhong

Sure. I have checked the Bioc-devel subscribers list. The email (nyzhoulang@gmail.com) I used in the authors list is in the subscribers list.

image image

Please double check the email you used in the authors list is subscribed to the bioc-devel mailing list. Others look great to me.

bioc-issue-bot commented 2 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 2 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/nyzhoulang.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("ggmsa"). The package 'landing page' will be created at

https://bioconductor.org/packages/ggmsa

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.