Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

JASPAR2024 #3168

Closed da-bar closed 11 months ago

da-bar commented 1 year 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 1 year ago

Hi @da-bar

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: JASPAR2024
Type: Package
Title: Data package for JASPAR database (version 2024)
Version: 0.99.1
Authors@R: person(given = "Damir", family = "Baranasic", role = c("aut", "cre"),
       email = "damir.baranasic@lms.mrc.ac.uk", 
       comment = c(ORCID = "0000-0001-5948-0932"))
Description: JASPAR (https://testjaspar.uio.no/) is a widely-used open-access 
   database presenting manually curated high-quality and non-redundant 
   DNA-binding profiles for transcription factors (TFs) across taxa.  
   In this 10th release and 20th-anniversary update, the CORE 
   collection has expanded with 329 new profiles. We updated three 
   existing profiles and provided orthogonal support for 72 profiles 
   from the previous release UNVALIDATED collection. Altogether, the 
   JASPAR 2024 update provides a 20 percent increase in CORE profiles 
   from the previous release. A trimming algorithm enhanced profiles 
   by removing low information content flanking base pairs, which were 
   likely uninformative (within the capacity of the PFM models) for 
   TFBS predictions and modelling TF-DNA interactions. This release 
   includes enhanced metadata, featuring a refined classification for 
   plant TFs structural DNA-binding domains. The new JASPAR 
   collections prompt updates to the genomic tracks of predicted 
   TF-binding sites in 8 organisms, with human and mouse tracks 
   available as native tracks in the UCSC Genome browser. All data are 
   available through the JASPAR web interface and programmatically 
   through its API and the updated Bioconductor and pyJASPAR packages. 
   Finally, a new TFBS extraction tool enables users to retrieve 
   predicted JASPAR TFBSs intersecting their genomic regions of 
   interest. 
Depends: R (>= 4.1.0), methods, BiocFileCache, utils
License: GPL-2
URL: https://testjaspar.uio.no//
NeedsCompilation: no
biocViews: AnnotationData, FunctionalAnnotation, AnnotationHub
LazyData: no
RoxygenNote: 7.2.3
Suggests:
    knitr,
    rmarkdown,
    BiocStyle,
    RSQLite
VignetteBuilder: knitr
bioc-issue-bot commented 1 year 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 1 year ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Build System.

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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): JASPAR2024_0.99.1.tar.gz macOS 12.6.5 Monterey: JASPAR2024_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/JASPAR2024 to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 11 months ago

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

bioc-issue-bot commented 11 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Build System.

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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): JASPAR2024_0.99.3.tar.gz macOS 12.6.5 Monterey: JASPAR2024_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/JASPAR2024 to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 11 months ago

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

bioc-issue-bot commented 11 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Build System.

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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): JASPAR2024_0.99.4.tar.gz macOS 12.6.5 Monterey: JASPAR2024_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/JASPAR2024 to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

lshep commented 11 months ago

Thank you for your submission. A few comments:

inst/

man

Cheers,

hpages commented 11 months ago

@da-bar About this:

> library(JASPAR2024)
Loading required package: BiocFileCache
Loading required package: dbplyr
adding rname 'https://testjaspar.uio.no/download/database/JASPAR2024.sqlite'
  |======================================================================| 100%

Packages should not download resources at load time. Any access to the internet should be done after the package is loaded. This guarantees that the package can always be loaded, even when offline.

In your case, an easy way to work around this is to provide a JASPAR2024 constructor function (e.g. JASPAR2024()) and to make the user explictely create the JASPAR2024 object right after loading the package:

library(JASPAR2024)
JASPAR2024 <- JASPAR2024()

A couple other minor things:

Thanks, H.

bioc-issue-bot commented 11 months ago

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

bioc-issue-bot commented 11 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Build System.

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 Bioconductor Build System: macOS 12.6.5 Monterey: JASPAR2024_0.99.5.tar.gz Linux (Ubuntu 22.04.2 LTS): JASPAR2024_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/JASPAR2024 to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 11 months ago

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

bioc-issue-bot commented 11 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Build System.

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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): JASPAR2024_0.99.6.tar.gz macOS 12.6.5 Monterey: JASPAR2024_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/JASPAR2024 to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

da-bar commented 11 months ago

Dear @lshep and @hpages , Thank you for your suggestions. I implemented the changes you suggested and:

  1. I created a bash script in inst/scripts which creates the sqlite database in the hub.
  2. I added the changes compared to the previous versions of JASPAR in the NEWS file.
  3. I added the actual database connection in the example as it is in the vignette.
  4. I added a JASPAR2024() constructor method for the JASPAR2024 class.
  5. I removed the brackets from the standardGeneric function definition.
  6. I substituted the paste0(path, "/metadata.csv") with system.file call

Please let me know if there are any other issues.

bioc-issue-bot commented 11 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 11 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/da-bar.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("JASPAR2024"). The package 'landing page' will be created at

https://bioconductor.org/packages/JASPAR2024

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.