Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

periodicDNA #1511

Closed js2264 closed 4 years ago

js2264 commented 4 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 4 years ago

Hi @js2264

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: periodicDNA
Type: Package
Title: Set of tools to identify periodic occurrences of k-mers in 
    DNA sequences
Version: 0.3.2
Date: 2020-05-03
Encoding: UTF-8
Author: Jacques Serizay
Maintainer: Jacques Serizay <jacquesserizay@gmail.com>
Description: The functions in this package provide a straightforward 
    approach to identify periodic occurrences of k-mers or 
    oligonucleotides in longer sequences such as regulatory 
    elements. 
URL: https://github.com/js2264/periodicDNA
BugReports: https://github.com/js2264/periodicDNA/issues
RoxygenNote: 7.1.0
Depends:
    R (>= 3.5),
    Biostrings, 
    GenomicRanges,
    IRanges
Imports: 
    S4Vectors,
    rtracklayer,
    stats, 
    GenomeInfoDb,
    magrittr, 
    zoo,
    ggplot2, 
    methods,
    parallel,
    cowplot
Suggests:
    BSgenome.Scerevisiae.UCSC.sacCer3, 
    BSgenome.Celegans.UCSC.ce11,
    BSgenome.Dmelanogaster.UCSC.dm6,
    BSgenome.Drerio.UCSC.danRer10,
    BSgenome.Hsapiens.UCSC.hg38,
    BSgenome.Mmusculus.UCSC.mm10,
    testthat,
    covr,
    knitr,
    rmarkdown,
    pkgdown
VignetteBuilder: knitr
biocViews:
    SequenceMatching,
    MotifDiscovery,
    MotifAnnotation, 
    Sequencing, 
    Coverage, 
    Alignment, 
    DataImport
License: GPL-3 + file LICENSE
bioc-issue-bot commented 4 years ago

A reviewer has been assigned to your package. Learn what to expect during the review process.

IMPORTANT: Please read the instructions for setting up a push hook on your repository, or further changes to your repository will NOT trigger a new build.

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

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

dbcc5b9 only 1 proc by default when plotting tracks; line ... 926470c remove rtracklayer import use aefc4d5 fix dependencies 1c66a80 bump version; fix maintainer

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

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

384249a git ignore non-R files 3721757 bump 0.99.1

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

429e2d0 Removing ignored files 24bf8f1 bump 0.99.2

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

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

js2264 commented 4 years ago

Hi @hpages, Thanks for reviewing this package! This is my first Bioconductor submission so hopefully I am not doing everything wrong. I solved the ERRORS I had when the package was built/checked by the Bioconductor package builder. From the latest report, I still have one WARNING:

"WARNING: Update R version dependency from 3.5 to 4.0."

I understand that ideally, new packages are written for the most recent version of R/Bioconductor. However, I have developed this package from a server using R 3.5, and it would be rather cumbersome to have to install a new version of R for this (I cannot devtools::check() the package if R dependency is >= 4.0.0). Moreover, I feel like a lot of users may not have updated their R version to 4.0.0, a major change.
In such context, is changing this dependency a required step for Bioconductor submission?

Thanks!

js2264 commented 4 years ago

Regarding the notes I got from the report:

  1. Recommended function length <= 50 lines: I have quite a lot of plotting functions that are long and cannot really be shortened... I did try to maximize the use of functions whenever possible and to avoid repeats.
  2. Consider shorter lines; 2 lines (0%) are > 80 characters: these are 2 https links in a .Rmd vignette, that are longer that 80 chars, but are not meant to be displayed anyway, as they are https links.
  3. Consider multiples of 4 spaces for line indents, 132 lines(3%) are not: not sure how to fix this... I generate my documentation using devtools::document() (devtools version 2.0.1, R 3.5.2 in Ubuntu 18.04.2), and somehow it uses 2-space tabs. Let me know if my full sessionInfo() could help here.

Would these 3 notes need to be addressed?

Thanks!

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

0ac1c9a cosmetic changes b3f24df fix bug in theme_ggplot2 3584d1b improve documentation 034ab3b bump 0.99.3

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

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

9949848 fix strand issue in getPeriodicityTrack 01ced38 bump 0.99.4

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

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

89276eb update tests 45d448b update manual 4132978 switch to BiocParallel for multi-thread jobs 9d21138 bump 0.99.5

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

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

587dcc2 fixed gitignore for vignettes bb70ad6 bump 0.99.6

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

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

807abb8 Revert "bump 0.99.5" This reverts commit 9d21138a... 518f45a bump 0.99.7

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

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

d2a6620 bump 0.99.8

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

js2264 commented 4 years ago

Hi @hpages,

Just to check, did you have a chance to read my previous message? The current warning is due to the version of R I specified in my dependencies. Let me know if you think it is ok or if I absolutely have to put R 4.0. Is the review process on going? I have a few minor commits to bump to Bioconductor build, but it is largely unchanged from 0.99.8.

Many thanks, J

Hi @hpages, Thanks for reviewing this package! This is my first Bioconductor submission so hopefully I am not doing everything wrong. I solved the ERRORS I had when the package was built/checked by the Bioconductor package builder. From the latest report, I still have one WARNING:

"WARNING: Update R version dependency from 3.5 to 4.0."

I understand that ideally, new packages are written for the most recent version of R/Bioconductor. However, I have developed this package from a server using R 3.5, and it would be rather cumbersome to have to install a new version of R for this (I cannot devtools::check() the package if R dependency is >= 4.0.0). Moreover, I feel like a lot of users may not have updated their R version to 4.0.0, a major change. In such context, is changing this dependency a required step for Bioconductor submission?

Thanks!

js2264 commented 4 years ago

HI @hpages, Sorry if I seem to be insisting too much, I am not completely sure of how the whole process of submission works. Should I bump the version (and the associated changes I have been working on recently) for the package to be reviewed? The commits waiting for a version bump are minor, but I could bump them now, in case you are waiting for them to review the whole package. Many thanks, Jacques

lshep commented 4 years ago

Yes Please bump the version so we have a complete version. We normally give reviewers approximately 2-3 weeks to get back reviews. @hpages will review your package shortly.

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

cf2f4ca improved vignettes; updated doc 9b69e9b improved plotting with p-values and threshold 68d2e31 added periodicityMetrics; 09ac06d improved getSignificantPeriods output & treatment ... 37fcaec bump 0.99.9

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

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

7d3a294 bump 0.99.10; fix Bioconductor errors (1)

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

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

a2fe848 bump 0.99.11

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

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

671fc07 bump 0.99.12; fix Bioconductor errors (2)

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

js2264 commented 4 years ago

I have now pushed the last commits and fixed the errors and warnings. The remaining warning is still about the R version specified in my dependencies

The current warning is due to the version of R I specified in my dependencies. Let me know if you think it is ok or if I absolutely have to put R 4.0.

Thx

js2264 commented 4 years ago

Dear @lshep and @hpages, Sorry to be annoying with this, as I am sure everybody is working on tight schedules. I'd like to submit a manuscript presenting periodicDNA for publication as soon as possible. Is it possible to get an idea of the timeline for the coming review of my package? Thank you very much, Jacques

js2264 commented 4 years ago

Dear @lshep and @hpages, Sorry again to bother you, but tomorrow will be 5 full weeks since I have submitted my package for review, and I have had no feedback until today. I would really like to submit a manuscript as soon as possible, but I would need the package to be available to publish it. The package submission information on Bioconductor states:

The entire review process typically takes between 2 and 5 weeks.

Could I please be informed whether there are any extraordinary circumstances that are delaying the review process?

Many thanks and sorry again for being so inquisitorial/pushy. Best, Jacques

hpages commented 4 years ago

Hi @js2264,

Thanks for your patience. You don't need (and should not) have a man page for every internal helper that you define (e.g. na.remove). That will just clutter the reference manual with dozens of functions that the end user doesn't care about and doesn't have access to and so will be quite confusing. Please remove them. To give an idea, the package exports 18 symbols so typically would not have more than 18 man pages (a few extra man pages for concepts and for the package level man page are ok).

Thanks!

hpages commented 4 years ago

Also no need to reinvent the wheel with char2BSgenome() when BSgenome::getBSgenome() does exactly that (and more). Thanks!

hpages commented 4 years ago

With respect to the current warning. Please keep in mind that the package is currently being tested with R 4.0 and that this is what you should also be using to develop and test it. The reason for this is that you're submitting a package for inclusion in BioC devel and BioC devel is targeting R 4.0 and R 4.0 only. So whether you update the R version dependency from 3.5 to 4.0 or not, once your package makes it in Bioconductor it will only be available to users that are running R >= 4.0.

Best

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

4130324 improved metrics report, added l2fc 679affd line length, FDR threshold abbc438 improved reporting of track function e7253f4 update doc 0e676e2 minor fixes 8e64b03 remove doZscore 0ad22c5 moved skipped tests 8a49b4d minor fixes 2125814 removed char2BSgenome; import stats; removed doc f... 150d4df bump 0.99.13

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

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

ee37bcb fix error: more than one installed BSgenome data p...

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

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

072e576 bump version 0.99.15

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

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

44341cb bump version 0.99.16; fix error: more than one ins...

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

js2264 commented 4 years ago

Hi @hpages, Thanks for your feedbacks, it is very useful.

Note: The last remaining warning is about the check which takes more than 10 min (only for the Linux build, apparently). I am note sure why it's only for 1 build but not the other. Should I deal with this?

Let me know if there is anything else you would want me to change! Best

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

f82162e bump 0.99.17