Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

OGRE submission #2431

Closed svenbioinf closed 2 years ago

svenbioinf commented 2 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 2 years ago

Hi @svenbioinf

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: OGRE
Type: Package
Title: Calculate, visualize and analyse overlap between genomic regions
Version: 0.99.0
Authors@R:c(
    person("Sven", "Berres", email="sven.berres@ukmuenster.de", role = c("aut","cre")),
    person("Jörg", "Gromoll", role = c("ctb")),
    person("Marius", "Wöste", role = c("ctb")),
    person("Sarah", "Sandmann", role = c("ctb")),
    person("Sandra", "Laurentino", role = c("ctb")))
Description: OGRE calculates overlap between user defined genomic region datasets. 
    Any regions can be supplied i.e. genes, SNPs, or reads from sequencing experiments. 
    Key numbers help analyse the extend of overlaps which can also be visualized at a genomic level.
License: Artistic-2.0
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
VignetteBuilder: knitr
RoxygenNote: 7.1.1
Imports: GenomicRanges, methods, data.table, assertthat, ggplot2, Gviz, IRanges
Depends: R (>= 4.0), S4Vectors
Suggests: knitr, rmarkdown
biocViews: Software, WorkflowStep, BiologicalQuestion, Annotation, Metagenomics,
    Visualization
bioc-issue-bot commented 2 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 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/OGRE 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: 45e68a52acce0aec119555c188fad90e619350a0

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/OGRE 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: c6ba03ba2d2c26f33ebc5f25cabe49ae0a0ffc40

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/OGRE 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: 36b9c1ae7df7ab073a0499832583bfe99acdeb7c

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

Kayla-Morrell commented 2 years ago

@svenbioinf - Thank you for submitting to Bioconductor. Please see the initial review of the package below. The required changes must be made while the suggested changes do not have to be (though we strongly encourage them). Comment back here with updates that have been made and when the package is ready for a re-review.

DESCRIPTION

NAMESPACE

NEWS

Data

Vignette

Unit testing

R code

Best, Kayla

Kayla-Morrell commented 2 years ago

@svenbioinf - Checking in to see if any progress has been made on the review I posted. We like to see changes within 2-3 weeks to be sure the package is actively being worked on. If there are no improvements made in the next few days I will have to close this issue for inactivity.

Best, Kayla

bioc-issue-bot commented 2 years ago

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

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

svenbioinf commented 2 years ago

@svenbioinf - Thank you for submitting to Bioconductor. Please see the initial review of the package below. The required changes must be made while the suggested changes do not have to be (though we strongly encourage them). Comment back here with updates that have been made and when the package is ready for a re-review.

DESCRIPTION

  • [x] SUGGESTION: Set LazyData to false.
  • [ ] REQUIRED: Update R version dependency from 4.0 to 4.2.0.
  • [x] SUGGESTION: Consider adding these automatically suggested biocViews: Sequencing.
  • [x] SUGGESTION: We strongly encourage the use of the 'BugReports:' field which includes a relevant link to GitHub for reporting Issues.

NAMESPACE

  • [ ] SUGGESTION: We strongly encourage the use of importFrom() over importing the entire package.
  • [x] SUGGESTION: Consider adding importFrom("grDevices", "dev.off", "pdf") and importFrom("stats", "setNames") to your NAMESPACE file.

NEWS

  • [x] SUGGESTION: Consider adding a NEWS file, so your package news will be included in Bioconductor release announcements.

Data

  • [x] REQUIRED: We require documentation of data in the inst/extdata/ directory to be present in the inst/scripts/ directory. The scripts in this directory can vary. Most importantly the script must clearly document how the data was generated. It should include source URLs and any key information regarding filtering or processing. It can be executable code, sudo code, or a text description. Users should be able to download and roughly reproduce the file or object that is present as data.

Vignette

  • [ ] SUGGESTION: We recommend using the BiocStyle package for formatting.
  • [x] REQUIRED: There should be an 'Installation' section that demonstrates to the user how to install and load the package from Bioconductor. The code should look like the following and include eval = FALSE.
if(!requireNamespace("BiocManager", quietly = TRUE))
  install.packages("BiocManager")
BiocManager::install("OGRE")
  • [x] REQUIRED: 'sessionInfo' not found in vignette(s).
  • [x] SUGGESTION: We encourage the use of a package man page with an overview of the package and links to the main functions.
  • [x] SUGGESTION: For any function that is documented but not exported I would suggest adding the @keywords internal tag so the function is removed from the documentation index.

Unit testing

  • [x] SUGGESTION: Consider adding unit tests. We strongly encourage them.

R code

  • [x] SUGGESTION: Partial argument match of 'chr' to 'chromosome' (this came from R CMD check).
  • [x] SUGGESTION: Consider clarifying how 8 object(s) are initialized. Maybe they are part of a data set loaded with data(), or perhaps part of an object referenced in with() or within().
  • [x] REQUIRED: Avoid sapply(); use vapply() if possible. Found in files: R/methods.R, lines 158 and 165.
  • [x] REQUIRED: Avoid 1:...; use seq_len() or seq_along() if possible. Found in files: methods.R, lines 221.
  • [ ] SUGGESTION: For formatting reasons, consider shorter lines. There are 93 lines that are > 80 characters long.
  • [ ] SUGGESTION: For formatting reasons, consider 4 spaces instead of tabs. There is 1 line that contains tabs.
  • [ ] SUGGESTION: For formatting reasons, consider multiples of 4 spaces for line indents. There are 153 lines that are not.

Best, Kayla

Hi Kayla, I managed to address various points during the christmas holidays, however there are a couple of issues I would appreciate your input:

Thank you for your support!

Best and Happy new year, Sven

bioc-issue-bot commented 2 years ago

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

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

svenbioinf commented 2 years ago

Dear Kayla, could you please comment on the note I wrote to you responding to your suggestion/requirements list? Here it is again: "Your internal MacOS buildcheck stops with "Graphics API version mismatch" It seems to be fine on Linux though are you able to do anything from your side?"

So I updated all my R packages, do you need to do the same for your MacOS testing system maybe? (Just guessing) Best, Sven

Kayla-Morrell commented 2 years ago

@svenbioinf - I will bring this to the attention of our team. I was able to build it locally on my mac so I'm assuming it's something on our end. In the mean time I will re-review the package based on the other builders. I will have the rereview posted here in the next few days.

Best, Kayla

bioc-issue-bot commented 2 years ago

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

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

svenbioinf commented 2 years ago

@svenbioinf - I will bring this to the attention of our team. I was able to build it locally on my mac so I'm assuming it's something on our end. In the mean time I will re-review the package based on the other builders. I will have the rereview posted here in the next few days.

Best, Kayla

@Kayla-Morrell Just to keep you updated: I added more of your suggested points, however the Error from your builder system still pops up. Best, Sven

Kayla-Morrell commented 2 years ago

@svenbioinf - Thank you for making the necessary changes. I've looked them over and everything looks good, I'm more than happy to accept the package. In regards to the Mac ERROR - this can be ignored for now. Our team did some digging and found that ggsave() uses packages ragg and textshaping which CRAN has not provided Mac binaries yet for R 4.2. Until this happens the ERROR will persist. If there are further changes that need to be made we will notify you.

Best, Kayla

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

https://bioconductor.org/packages/OGRE

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.

svenbioinf commented 2 years ago

Thank you Kayla & the Bioconductor Team! This is good news and I am happy to have OGRE accepted here at Bioconductor. Have a nice day, Sven