Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

SingleMoleculeFootprintingData #2034

Closed GuidoBarzaghi closed 3 years ago

GuidoBarzaghi 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 help with submitting your package, please subscribe and post questions to the bioc-devel mailing list.

bioc-issue-bot commented 3 years ago

Hi @GuidoBarzaghi

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: SingleMoleculeFootprintingData
Type: Package
Title: Data supporting the SingleMoleculeFootprinting pkg
Version: 0.99.0
Authors@R: c(
    person(given = "Guido",
 family = "Barzaghi",
 role = c("aut", "cre"),
 email = "guido.barzaghi@embl.de",
 comment = c(ORCID = "0000-0001-6066-3920")),
    person(given = "Arnaud",
 family = "Krebs",
 role = c("aut"),
 email = "arnaud.krebs@embl.de",
 comment = c(ORCID = "0000-0001-7999-6127")),
    person(given = "Mike",
 family = "Smith",
 role = c("ctb"),
 email = "mike.smith@embl.de",
 comment = c(ORCID = "0000-0002-7800-3848"))
    )
Description: This Data package contains r objcets necessary to run some of the
    functions from the SingleMoleculeFootprinting package. 
    SingleMoleculeFootprinting is an R package providing functions 
    to analyze Single Molecule Footprinting (SMF) data.
biocViews: 
    ExperimentHub, ExperimentData, SequencingData
License: GPL-3
Encoding: UTF-8
LazyData: true
Imports:
    ExperimentHub,
    utils
Suggests: 
    knitr,
    rmarkdown,
    QuasR,
    GenomicRanges,
    BSgenome.Mmusculus.UCSC.mm10
VignetteBuilder: knitr
RoxygenNote: 7.1.1
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/SingleMoleculeFootprintingData 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: 4d303a44be346592ac57a3004d204028bceb45d5

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/SingleMoleculeFootprintingData 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: d17d8cb7950e0b6f6153e3a9a1a155c7f4e9a804

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/SingleMoleculeFootprintingData 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: c882029d08a35b30a3bb11e8d070289da18e0092

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/SingleMoleculeFootprintingData 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: 1acbadfe3f3d518a939432cf2693e3a728e3c879

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

GuidoBarzaghi commented 3 years ago

AdditionalPackage: https://github.com/GuidoBarzaghi/SingleMoleculeFootprinting

bioc-issue-bot commented 3 years ago

Hi @GuidoBarzaghi, Thanks for submitting your additional package: https://github.com/GuidoBarzaghi/SingleMoleculeFootprinting. We are taking a quick look at it and you will hear back from us soon.

GuidoBarzaghi commented 3 years ago

Hi @LiNk-NY,

I was wondering whether I misunderstood the procedure for submitting an additional package. I was expecting for it to automatically go through the build checks analogously to what happened to the primary one. Is there something I did wrong that is causing the system not to be prompted?

bioc-issue-bot commented 3 years ago

Additional Package has been approved for building.

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.

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

LiNk-NY commented 3 years ago

Hi Guido, @GuidoBarzaghi It looks like the procedure to add the package worked out smoothly. Please see the result report and modify accordingly.

bioc-issue-bot commented 3 years ago

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

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/SingleMoleculeFootprinting 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: 9235a89b51b2d6785d488e2fc23dce77c59f91fa

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

GuidoBarzaghi commented 3 years ago

@LiNk-NY thanks a lot for your reply. This is my first ever submission to Bioconductor so I'm not entirely sure on what to expect at each step.

I'm afraid I need to ask for your input again: there is an ERROR reported under the "tokay2 BUILD BIN output" section that I'm not sure how to tackle. I'm not entirely sure how I can influence the installation of dependencies on windows. Do you have any suggestion?

grimbough commented 3 years ago

@GuidoBarzaghi It looks like Rbowtie & subsequently QuasR aren't available for 32-bit Windows. You can specify not to build your package on that platform by adding the file .BBSoptions to the root of your package. It should be fine to copy the one from QuasR at https://github.com/fmicompbio/QuasR/blob/master/.BBSoptions

bioc-issue-bot commented 3 years ago

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

GuidoBarzaghi commented 3 years ago

@grimbough Oh I see. Thank you for clarifying!

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: "TIMEOUT, WARNINGS, 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/SingleMoleculeFootprinting 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: e249370a1a73c2246cdb8d33b866a2af8cd03714

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: "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. 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/SingleMoleculeFootprinting 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: 5d9763b30cbb9980dc83b78094032eee1b532b9b

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: "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. 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/SingleMoleculeFootprinting 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: d45f3466369e3dd249828a1e24e086a4f5758662

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/SingleMoleculeFootprinting 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: 335ba6149259df2067a3b726d92ede7f30a8fecc

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

LiNk-NY commented 3 years ago

Hi Guido, @GuidoBarzaghi

Thank you for your submission. Please see the reviews below. Feel free to comment with questions.

Best regards, Marcel


SingleMoleculeFootprinting #2034

DESCRIPTION

NAMESPACE

vignettes

Minor:

R

tests


SingleMoleculeFootprintingData

DESCRIPTION

vignette

LiNk-NY commented 3 years ago

Note. For more information, see:

BiocCheck::BiocCheck("SingleMoleculeFootprinting")
bioc-issue-bot commented 3 years ago

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

bioc-issue-bot commented 3 years ago

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

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/SingleMoleculeFootprintingData 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

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: "skipped, 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/SingleMoleculeFootprinting 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: 3219e106bfcafcbb4a43b9603fe7c6c493ed7e48

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/SingleMoleculeFootprinting 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: f061feeb9c9d7508f5ee8ab7b973fd1e6df0ae97

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/SingleMoleculeFootprinting 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: 876c98439222acbb2e16afcf91c725f71199f530

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/SingleMoleculeFootprinting 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: b7a89f0b32218c3e617f890fc38a18e8b9501ad5

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

GuidoBarzaghi commented 3 years ago

@LiNk-NY thanks a lot for your comments. I have tried to thoroughly address all the points you brought up.

I would just like to offer some clarifications about a couple of them:

DESCRIPTION:

In this case, some of the objects accessed through the data package are necessary for a couple of functions to work. Therefore it is necessary to import the data package when loading the software one

VIGNETTE:

I actually just copy it in order to rename it with a relevant extension. This is necessary for one of the dependencies of SingleMoleculeFootprinting to recognise these files.

Unfortunately, qQCreport will not run with a dataset that is too small (such is the case for the example data provided through SingleMoleculeFootprintingData). Consequently, I removed the code chunk relative to this and referred to the documentation of the package QuasR relative to the function qQCreport.

R:

Because of this and other comments, I removed all the instances of makeCluster/stopCluster across the package and leave to the user the choice of how to create a cluster object. Still in the vignette and the example code in the function manuals I show how to do this using parallel since this is how the documentation of the dependency QuasR indicates.

Unfortunately where numeric indices are still present they are strictly necessary as of now, I will keep this in mind for the future.

Once again, thanks for your suggestions I will keep them in mind as I go along and keep developing in the future. Let me know if I can further clarify something.

LiNk-NY commented 3 years ago

Hi Guido, @GuidoBarzaghi

DESCRIPTION:

  • Most often, the data package goes in the Suggests field.

In this case, some of the objects accessed through the data package are necessary for a couple of functions to work. Therefore it is necessary to import the data package when loading the software one

I would not require everyone to install data package. Only the users using those functions should install the data package. You can implement this using some logic to check for the package availability (after putting the package in Suggests):

if (!requireNamespace("LargeDataPackage", quietly = TRUE))
    stop("Install the 'LargeDataPackage' to use this function")

VIGNETTE:

  • Please don't move the file and keep it in the default cache. Otherwise, your package will be downloading the data every time it gets checked on our build system (BBS).

I actually just copy it in order to rename it with a relevant extension. This is necessary for one of the dependencies of SingleMoleculeFootprinting to recognise these files.

I see the issue now. I think the software should work regardless of the extension but you don't have any control of QuasR... I will ask about a way to preserve the file extension.

Thanks! Best, Marcel