Bioconductor / Contributions

Contribute Packages to Bioconductor
131 stars 33 forks source link

betaHMM submission #3154

Closed koyelucd closed 7 months ago

koyelucd commented 10 months 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 10 months ago

Hi @koyelucd

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: betaHMM
Type: Package
Title: A Hidden Markov Model Approach for Identifying Differentially Methylated 
       Sites and Regions for Beta-Valued DNA Methylation Data
Version: 0.99.0
Authors@R: c(person("Koyel","Majumdar",email="koyel.majumdar@ucdconnect.ie",
        role=c("cre","aut"),comment = c(ORCID = "0000-0001-6469-488X")),
        person("Romina","Silva",
        role="aut"),
        person("Antoinette Sabrina","Perry",
        role="aut"),
        person("Ronald William","Watson",
        role="aut"),
        person("Isobel Claire","Gorley",email="claire.gormley@ucd.ie",
        role="aut", comment=c(ORCID="0000-0001-7713-681X")),
        person("Thomas Brendan","Murphy",email="brendan.murphy@ucd.ie",
        role="aut",comment=c(ORCID="0000-0002-5668-7046")),
        person("Florence","Jaffrezic",email="florence.jaffrezic@inrae.fr",
        role="aut"),
        person("Andrea","Rau",email="andrea.rau@inrae.fr",role="aut",
        comment = c(ORCID = "0000-0001-6469-488X")))
Description: A novel approach utilizing a homogeneous hidden Markov model. And
  effectively model untransformed beta values. To identify DMCs while 
  considering the spatial. Correlation of the adjacent CpG sites.
License: GPL-3
Encoding: UTF-8
Imports: stats,  
         ggplot2, 
         scales,
         methods,
         pROC,
         foreach,
         doParallel,
         parallel,
         cowplot,
         dplyr,
         tidyr,
         stringr,
         utils
Depends: R (>= 4.3.0), SummarizedExperiment, S4Vectors
RoxygenNote: 7.2.3
biocViews: DNAMethylation, DifferentialMethylation, ImmunoOncology, 
 BiomedicalInformatics, MethylationArray, Software, 
 MultipleComparison, Sequencing, Spatial, Coverage, 
 GeneTarget, HiddenMarkovModel, Microarray
Suggests: 
    rmarkdown,
    knitr,
    testthat (>= 3.0.0)
VignetteBuilder: knitr
Config/testthat/edition: 3
bioc-issue-bot commented 9 months ago

Your package has been added to git.bioconductor.org to continue the pre-review process. A build report will be posted shortly. Please fix any ERROR and WARNING in the build report before a reviewer is assigned or provide a justification on why you feel the ERROR or WARNING should be granted an exception.

IMPORTANT: Please read this documentation for setting up remotes to push to git.bioconductor.org. All changes should be pushed to git.bioconductor.org moving forward. It is required to push a version bump to git.bioconductor.org to trigger a new build report.

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 9 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Build System.

On one or more platforms, the build results were: "WARNINGS". 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.

The following are build products from R CMD build on the Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): betaHMM_0.99.0.tar.gz macOS 12.6.5 Monterey: betaHMM_0.99.0.tar.gz

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

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Build System.

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

Please see the build report for more details.

The following are build products from R CMD build on the Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): betaHMM_0.99.1.tar.gz macOS 12.6.5 Monterey: betaHMM_0.99.1.tar.gz

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

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Build System.

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

Please see the build report for more details.

The following are build products from R CMD build on the Bioconductor Build System: macOS 12.6.5 Monterey: betaHMM_0.99.2.tar.gz Linux (Ubuntu 22.04.2 LTS): betaHMM_0.99.2.tar.gz

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

lshep commented 9 months ago

Please consider renaming your vignette to something more descriptive; we strongly suggest the package name. Using generic vignette can result in naming conflicts depending on the order or packages loading.

bioc-issue-bot commented 9 months ago

A reviewer has been assigned to your package for an indepth review. Please respond accordingly to any further comments from the reviewer.

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Build System.

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

Please see the build report for more details.

The following are build products from R CMD build on the Bioconductor Build System: macOS 12.6.5 Monterey: betaHMM_0.99.3.tar.gz Linux (Ubuntu 22.04.2 LTS): betaHMM_0.99.3.tar.gz

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

jianhong commented 9 months ago

Package 'betaHMM' Review

Thank you for submitting your package to Bioconductor. The package passed check and build. However there are several things need to be fixed. Please try to answer the comments line by line when you are ready for a second review. Code: Note: please consider; Important: must be addressed.

The NAMESPACE file

General package development

R code

Documentation

koyelucd commented 8 months ago

Thank you for taking the time to review our package. I will look into the points you mentioned, update the package accordingly, and let you know once done.

Kind regards, Koyel.

jianhong commented 7 months ago

Should I expect any updates soon?

koyelucd commented 7 months ago

Hi Jianhong,

I am working on the changes and will be pushing the changes soon.

Kind regards, Koyel.

bioc-issue-bot commented 7 months ago

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

bioc-issue-bot commented 7 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Single Package Builder.

On one or more platforms, the build results were: "WARNINGS". 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.

The following are build products from R CMD build on the Single Package Builder: macOS 12.7.1 Monterey: betaHMM_0.99.4.tar.gz Linux (Ubuntu 22.04.2 LTS): betaHMM_0.99.4.tar.gz

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

koyelucd commented 7 months ago

Hi Jianhong,

Thank you for reviewing the package. I have done the changes as suggested. The build report came back with WARNINGS but I cannot seem to find the reason why warning was issued. Please let me know if you can see why WARNINGS were added to the build report.

Please find below the comments on the feedback provided:

Please let me know if anything else needs to be changed and I will work on the package accordingly.

Kind regards, Koyel.

jianhong commented 7 months ago

Package 'betaHMM' Review

It is almost there. Please try to answer the comments line by line when you are ready for a second review. Code: Note: please consider; Important: must be addressed.

The NAMESPACE file

koyelucd commented 7 months ago

Hi Jianhong,

Thank you for your feedback.

I had missed replacing one import which I will rectify.

For the unit test cases, could you please tell me how much coverage is needed? I have added more test cases which I could think of and getting around 25.72% coverage.

Kind regards, Koyel.

koyelucd commented 7 months ago

Hi Jianhong,

I am attaching the coverage result for your reference:

Package Coverage
jianhong commented 7 months ago

Almost there. My suggestion will be over 30%. But it is just suggestion.

bioc-issue-bot commented 7 months ago

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

bioc-issue-bot commented 7 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Single Package Builder.

On one or more platforms, the build results were: "WARNINGS". 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.

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.2 LTS): betaHMM_0.99.5.tar.gz macOS 12.7.1 Monterey: betaHMM_0.99.5.tar.gz

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

koyelucd commented 7 months ago

Hi Jianhong,

Thank you for your suggestion.

[X] Selective imports using importFrom instead of import all with import. -- I have rectified it.

[X] Consider adding more unit tests. Current unit tests only covered 7.19%. -- I have added the unit tests and the coverage is now 34%.

Thank you, Koyel.

bioc-issue-bot commented 7 months 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 7 months ago

The default branch of your GitHub repository has been added to Bioconductor's git repository as branch devel.

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/koyelucd.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("betaHMM"). The package 'landing page' will be created at

https://bioconductor.org/packages/betaHMM

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.