Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

regutools #1393

Closed josschavezf closed 4 years ago

josschavezf 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 @josschavezf

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: regutools
Title: regutools: an R package for data extraction from RegulonDB
Version: 0.99.0
Date: 2020-02-26
Authors@R: c(
    person ("Joselyn", "Chavez", email =  "joselynchavezf@gmail.com",
        role = c("aut", "cre"), comment = c(ORCID = "0000-0002-4974-4591")),
    person("Carmina", "Barberena-Jonas", email = "car.barjon@gmail.com",
        role = c("aut", "cre")),
    person(c("Jesus", "E."), "Sotelo-Fonseca", email = "jemilianosf@gmail.com",
        role = c("aut", "cre")),
    person("Jose", "Alquicira-Hernandez", email = "joseah@lcg.unam.mx",
        role = c("ctb"), comment = c(ORCID = "0000-0002-9049-7780")),
    person("Heladia", "Salgado", email = "heladia@ccg.unam.mx",
        role = c("ctb"), comment = c(ORCID = "0000-0002-3166-5801")),
    person("Leonardo", "Collado-Torres", role = c("aut"),
        email = "lcolladotor@gmail.com",
        comment = c(ORCID = "0000-0003-2140-308X")),
    person("Alejandro", "Reyes", email = "alejandro.reyes.ds@gmail.com",
        role = c("aut"), comment = c(ORCID = "0000-0001-8717-6612"))
    )
Description: This package provides an interface to the RegulonDB
    http://regulondb.ccg.unam.mx/ database such that you can query it using
    R and easily work with Bioconductor packages. This package was created
    as a collaboration by members of the Community of Bioinformatics
    Software Developers (CDSB in Spanish) https://comunidadbioinfo.github.io/.
License: Artistic-2.0
Encoding: UTF-8
Depends: R (>= 3.6.0)
Imports:
    AnnotationDbi,
    AnnotationHub,
    Biostrings,
    data.table,
    DBI,
    GenomicRanges,
    Gviz,
    IRanges,
    RCy3,
    RSQLite,
    S4Vectors,
    methods,
    stats,
    utils
LazyData: true
RoxygenNote: 7.0.2
Suggests: 
    BiocStyle,
    knitcitations,
    knitr,
    rmarkdown,
    sessioninfo,
    testthat (>= 2.1.0)
URL: https://github.com/ComunidadBioInfo/regutools
BugReports: https://github.com/ComunidadBioInfo/regutools/issues
biocViews: AnnotationData, AnnotationHub, Escherichia_coli,
    FunctionalAnnotation, CustomDBSchema
Roxygen: list(markdown = TRUE)
VignetteBuilder: knitr

Add SSH keys to your GitHub account. SSH keys will are used to control access to accepted Bioconductor packages. See these instructions to add SSH keys to your GitHub account.

josschavezf commented 4 years ago

regutools has three maintainers: -@josschavezf -@jemilianosf -@carbarjon

This package is part of the community CDSB http://comunidadbioinfo.github.io/

jemilianosf commented 4 years ago

I acknowledge that I am a maintainer of regutools.

CarBarJon commented 4 years ago

I acknowledge that I am a maintainer of regutools.

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: "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.

bioc-issue-bot commented 4 years ago

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

16da039 v0.99.1 -- address as many issues from http://bioc...

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:

957be1c Removed the Rproj file =( ``` $ echo "*.Rproj" >>... 5a77624 v0.99.2 -- remove the .Rproj file :'( and bumped R...

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.

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

Please see the build report for more details.

nturaga commented 4 years ago

Hi.

Please note that Bioconductor allows only one maintainer on the package.

Only one person should be listed in the Maintainer field to ensure a single point of contact. This person by default will have commit access to the git repository on git.bioconductor.org. Commit access can be given to other developers by request on the bioc-devel mailing list. Another option is to add collaborators to the github repository. This approach enables development by many but restricts push access to git.bioconductor.org.

http://bioconductor.org/developers/package-guidelines/#description

You can have multiple authors as collaborators though.

Please make the change needed in the DESCRIPTION file. And as initial additional commentary, the Description section on the DESCRIPTION file should match a paper's abstract. Please make the changes needed.

bioc-issue-bot commented 4 years ago

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

8e1c802 update Description with an article-like summary f5a28b0 fix bug with Cytoscape conection by setting visual... c83d194 update package Description 78393d9 update package version to 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.

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

Please see the build report for more details.

nturaga commented 4 years ago

Review

R CMD build

R CMD INSTALL

DESCRIPTION

NAMESPACE

NEWS

Tests

R

vignette

man

lcolladotor commented 4 years ago

Hi,

Regarding man/figures that's because pkgdown and usethis::use_logo() default to that location for saving the man/figures/logo.png file https://usethis.r-lib.org/reference/use_logo.html. I suggested to Carmina, Joselyn and Emiliano that they make a package sticker/logo. And they did so https://github.com/ComunidadBioInfo/regutools/tree/master/man/figures.

Best, Leo

lcolladotor commented 4 years ago

@CarBarJon @jemilianosf @josschavezf

Regarding the note by Nitesh about news.md https://github.com/ComunidadBioInfo/regutools/blob/master/NEWS.md I think that if you make it look like https://github.com/leekgroup/recount/blob/master/NEWS.md then it would be ok.

As for the line-wrapping, I think that we've used RStudio's reindent lines utilities. But well, it doesn't guarantee the 80 chars per line. I think that there are only a few lines left to fix manually if you can do that.

Screen Shot 2020-04-02 at 12 42 37 PM

Best, Leo

bioc-issue-bot commented 4 years ago

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

4108931 version updated to 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.

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

Please see the build report for more details.

bioc-issue-bot commented 4 years ago

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

fa9f1ac Update NEWS for version 0.99.5 05eb391 bump to version 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: "TIMEOUT". 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:

8497185 bump version to 0.99.6

nturaga commented 4 years ago

Hi,

I'm satisfied with the changes made. If you do a version bump and the build report is clean, I can accept the package.

EDIT: Oops, I saw that you made a bump 13 mins ago. I'll wait.

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.

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

Please see the build report for more details.

bioc-issue-bot commented 4 years ago

Your package has been accepted. It will be added to the Bioconductor Git repository and nightly builds. Additional information will be posed to this issue in the next several days.

Thank you for contributing to Bioconductor!

mtmorgan commented 4 years ago

Using the 'AnnotationData' biocViews term means that this would be classified as an 'annotation' package, but it's clearly a software package that allows access to a particular type of annotation data.

Please update the biocViews terms to be strictly from the 'Software' hierarchy.

bioc-issue-bot commented 4 years ago

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

a990fbc v0.99.7 -- fix pkgdown deployment based on the sol...

bioc-issue-bot commented 4 years ago

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

ba77100 v0.99.8 -- Change biocViews

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.

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

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.

bioc-issue-bot commented 4 years ago

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

add3846 bump to version 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: "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.

josschavezf commented 4 years ago

Hi @nturaga,

During the last 2 bumps, we are getting this warning 'WARNING: R CMD check exceeded 10 min requirement.' but I am not sure how to solve it. Could you please help us to understand the error or have any suggestions?

nturaga commented 4 years ago

Can you try a version bump to see if it happens again?

bioc-issue-bot commented 4 years ago

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

5686d33 bump to version 0.99.10

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.

josschavezf commented 4 years ago

Hi @nturaga,

I bumped version but now a different error has appeared:

But I have not moved any file, news file is located at ./NEWS.md as before.

bioc-issue-bot commented 4 years ago

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

d8a9bbf add description for version 0.99.11 dca65a0 manual adjustment for lines > 80 chr in params des... ae9f271 add description for version 0.99.11 2b72973 version bump to 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

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.

lshep commented 4 years ago

The NEWS file ERROR is on our end. Very sorry for the confusion. I have a fix on the linux builder and windows should be cleared up by this afternooon. I'll kick off a manual build now so you should at least have an accurate linux 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: "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.

nturaga commented 4 years ago

@josschavezf

Some pointers about the time the package takes to complete the R CMD check,

> system.time(library(regutools))
   user  system elapsed
 10.808   0.527  11.411
Warning message:
call dbDisconnect() when finished working with a connection
mtmorgan commented 4 years ago

Ideally regulondb_v10.6.2_DM_sqlite3 should be placed in ExperimentHub, which will manage file cache for you. This would not be feasible if the file requires frequent update, but even then the record to the metadata for the file could be placed in ExperimentHub, with the resource hosted in a location that could be conveniently updated.

lcolladotor commented 4 years ago

Hi,

I didn't think about the download part being the problem, but it makes total sense.

regutools is designed to have the SQL data at AnnotationHub, it's just that https://github.com/ComunidadBioInfo/regutools/blob/master/R/connect_database.R has a fall-back mechanism that downloads the data from Dropbox if the data is not available from AnnnotationHub (if you think that ExperimentHub is better, we'll make that small switch). It seems to me that at this point then it would be best to get the data uploaded at AnnotationHub so the code will work and thus the data will get cached.

I could also add BiocFileCache as a dependency and use it for the fall-back mechanism in connect_database() (aka, the files from Dropbox). I guess that after all, BiocFileCache is already an indirect dependency by depending on AnnotationHub (importing in strict terms).

This is something I helped them with since I had done something similar for GenomicState in 2019 (and now I'm doing the same for spatialLIBD).

Best, Leo

bioc-issue-bot commented 4 years ago

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

d254e8a v0.99.12 -- Switch to GitHub actions as described ... 4f1c9d5 Add files missing in the previous commit 629aecd Update README.md

bioc-issue-bot commented 4 years ago

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

c50700a v0.99.13 -- Use BiocFileCache for caching the db w...

lcolladotor commented 4 years ago

Hi again,

In https://github.com/ComunidadBioInfo/regutools/commit/c50700a1d8b461eedae6659342a13665127cf8a7 I now use BiocFileCache to cache the data when it's not available from AnnotationHub. I still think that it would be great to add the data to AnnotationHub. I believe that regutools has everything already setup for that, we'd just need the AWS info to do so from Lori I think @lshep.

We'll see in a few minutes what the SPB and the GHA reports say.

I'll explain these changes to the regutools team on our meeting this Thursday.

Best, Leo

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:

8d9e4f9 v0.99.14 -- update the arguments and help page for...

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.

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

Please see the build report for more details.