Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

dinoR #3273

Closed xxxmichixxx closed 6 months ago

xxxmichixxx commented 8 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 8 months ago

Hi @xxxmichixxx

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: dinoR
Title: Differential NOMe-seq analysis
Version: 0.99.0
Authors@R: 
    person("Michaela", "Schwaiger",, "michaela.schwaiger@fmi.ch", role = c("aut", "cre"),
 comment = c(ORCID = "0000-0002-4522-7810"))
Description: dinoR tests for significant differences in NOMe-seq
    footprints between two conditions, 
    using genomic regions of interest (ROI) centered around a landmark, 
    for example a transcription factor (TF) motif. 
    This package takes NOMe-seq data (GCH methylation/protection) in the form of a Ranged Summarized Experiment as  input. 
    dinoR can be used to group sequencing fragments into 3 or 5 categories representing characteristic footprints (TF bound, nculeosome bound, open chromatin),
    plot the percentage of fragments in each category in a heatmap, or averaged across different ROI 
    groups, for example, containing a common TF motif. It is designed
    to compare footprints between two sample groups, using edgeR's quasi-likelihood methods on the total
    fragment counts per ROI, sample, and footprint category.
License: MIT + file LICENSE
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
Suggests: 
    knitr,
    rmarkdown,
    testthat (>= 3.0.0)
Config/testthat/edition: 3
VignetteBuilder: knitr
Imports: 
    BiocGenerics,
    circlize,
    ComplexHeatmap,
    cowplot,
    dplyr,
    edgeR,
    GenomicRanges,
    ggplot2,
    Matrix,
    rlang,
    stats,
    stringr,
    SummarizedExperiment,
    tibble,
    tidyr,
    tidyselect
Depends: 
    R (>= 4.3.0)
LazyData: false
biocViews: 
    NucleosomePositioning,
    Epigenetics,
    MethylSeq,
    DifferentialMethylation,
    Coverage,
    Transcription,
    Sequencing,
    Software
URL: https://github.com/xxxmichixxx/dinoR
BugReports: https://github.com/xxxmichixxx/dinoR/issues
bioc-issue-bot commented 8 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 8 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: "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.

The following are build products from R CMD build on the Single Package Builder: macOS 12.7.1 Monterey: dinoR_0.99.0.tar.gz Linux (Ubuntu 22.04.2 LTS): dinoR_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/dinoR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 8 months ago

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

bioc-issue-bot commented 8 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: dinoR_0.99.1.tar.gz Linux (Ubuntu 22.04.3 LTS): dinoR_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/dinoR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 8 months ago

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

bioc-issue-bot commented 8 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: dinoR_0.99.2.tar.gz Linux (Ubuntu 22.04.3 LTS): dinoR_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/dinoR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 8 months ago

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

bioc-issue-bot commented 8 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: "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.

The following are build products from R CMD build on the Single Package Builder: macOS 12.7.1 Monterey: dinoR_0.99.3.tar.gz Linux (Ubuntu 22.04.3 LTS): dinoR_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/dinoR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 8 months ago

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

bioc-issue-bot commented 8 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: "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.

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.3 LTS): dinoR_0.99.4.tar.gz macOS 12.7.1 Monterey: dinoR_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/dinoR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 8 months ago

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

bioc-issue-bot commented 8 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: dinoR_0.99.5.tar.gz Linux (Ubuntu 22.04.3 LTS): dinoR_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/dinoR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 8 months ago

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

bioc-issue-bot commented 8 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.3 LTS): dinoR_0.99.6.tar.gz macOS 12.7.1 Monterey: dinoR_0.99.6.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/dinoR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 7 months ago

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

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.

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 Single Package Builder: Linux (Ubuntu 22.04.3 LTS): dinoR_0.99.7.tar.gz macOS 12.7.1 Monterey: dinoR_0.99.7.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/dinoR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 7 months ago

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

lshep commented 7 months ago

Thank you for your submission. Please see comments below:

inst

man

vignette

NAMESPACE

R code

bioc-issue-bot commented 6 months ago

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

xxxmichixxx commented 6 months ago

Thank you for the helpful review. Please see my answers below:

inst

The data for the vignette were moved to the data directory as suggested, and are described in data.R. The other two small data files were removed and data are generated directly in the examples now.

man

I added a package man page.

vignette

An introduction was added and installation instructions were updated.

The fetch-NOMe function will be submitted to Bioconductor as part of a bigger package later. I can submit the NOMeConverteR package already, or add the function to dinoR. However, it might make sense to wait for fetch-NOMe since NOMeConverteR has only one function that is to convert the fetch-NOMe output into a Ranged Summarized Experiment? In the meantime, I suggest an alternative package that is available on Bioconductor in the vignette, that can be used to map the reads and get the methylation calls.

I moved the data for the vignette so they can be loaded with data().

I split the two different steps for "Determine fragment counts for five chromatin patterns” and added more explanations.

NAMESPACE

I added SummarizedExperiment to the “depends” section of the DESCRIPTION.

R code

I formatted all code and text to match the BiocCheck reccomendations (except the automatically generated .rd files). I added argument checking to all functions.

bioc-issue-bot commented 6 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.

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 Single Package Builder: Linux (Ubuntu 22.04.3 LTS): dinoR_0.99.8.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/dinoR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

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

https://bioconductor.org/packages/dinoR

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.