Bioconductor / Contributions

Contribute Packages to Bioconductor
131 stars 33 forks source link

scanMiRApp #2208

Closed plger closed 2 years ago

plger commented 2 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 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.

@lshep @vjcitn , following-up on the scanMiR submission, I guess it makes more sense if someone already familiar with the whole thing handles the review?

bioc-issue-bot commented 2 years ago

Hi @plger

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: scanMiRApp
Type: Package
Title: scanMiR shiny application
Version: 0.99.17
Date: 2021-07-06
Authors@R: c(
    person("Pierre-Luc", "Germain", email="pierre-luc.germain@hest.ethz.ch", 
      role=c("cre","aut"), comment=c(ORCID="0000-0003-3418-4218")),
    person("Michael", "Soutschek", email="michael.soutschek@hest.ethz.ch", role="aut"),
    person("Fridolin", "Gross", email="fridolin.gross@hest.ethz.ch", role="ctb"))
Imports:
    AnnotationDbi,
    AnnotationFilter,
    AnnotationHub,
    BiocParallel,
    Biostrings,
    data.table,
    digest,
    DT,
    ensembldb,
    fst,
    GenomeInfoDb,
    GenomicFeatures,
    GenomicRanges,
    ggplot2,
    htmlwidgets,
    IRanges,
    Matrix,
    methods,
    plotly,
    rintrojs,
    rtracklayer,
    S4Vectors,
    scanMiR,
    scanMiRData,
    shiny,
    shinycssloaders,
    shinydashboard,
    stats,
    utils,
    waiter
Suggests: 
    knitr,
    rmarkdown,
    BiocStyle,
    testthat (>= 3.0.0)
Description:
    A shiny interface to the scanMiR package. The application enables the 
    scanning of transcripts and custom sequences for miRNA binding sites, the 
    visualization of KdModels and binding results, as well as browsing predicted
    repression data. In addition contains the IndexedFst class for fast indexed
    reading of large GenomicRanges or data.frames, and some utilities for 
    facilitating scans and identifying enriched miRNA-target pairs.
Depends: R (>= 4.0)
License: GPL-3
VignetteBuilder: knitr
RoxygenNote: 7.1.1
biocViews: miRNA, SequenceMatching, GUI
Config/testthat/edition: 3
plger commented 2 years ago

There's currently one check warning, namely the use of calls like: BSgenome.Hsapiens.UCSC.hg38:::BSgenome.Hsapiens.UCSC.hg38 The idea is to make building the annotation easy, but not require a systematic installation of those genome packages, since a user might just need one of them (or none). The error message when it's not installed is pretty clear... but if you have better suggestions about how to proceed with this kind of issue, we're all ears! Thanks in advance, PL

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

bioc-issue-bot commented 2 years ago

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

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

bioc-issue-bot commented 2 years ago

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

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

plger commented 2 years ago

sorry, a breaking commit had been pushed in the meantime... now we're back to just the aforementioned warning.

vjcitn commented 2 years ago

This is looking great and I am glad you have some unit tests. Have you had a look at https://shiny.rstudio.com/articles/testing-overview.html and have you tried it?

bioc-issue-bot commented 2 years ago

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

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

plger commented 2 years ago

Thanks @vjcitn , I hadn't, I now added some server tests (what I could easily with toy data).

vjcitn commented 2 years ago

Thanks a lot for trying this out. I got

Performing 3' alignment...
── Failure (test-shiny.R:11:3): shiny app (server) works ───────────────────────
start(h) (`actual`) not equal to c(281L, 482L) (`expected`).

  `actual`:   1   1
`expected`: 281 482
Backtrace:
  1. shiny::testServer(...) test-shiny.R:11:2
 22. testthat::expect_equal(start(h), c(281L, 482L)) test-shiny.R:26:4

I think you need GenomicRanges::start ...

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

vjcitn commented 2 years ago

Please look at the warnings.

plger commented 2 years ago

Oops, indeed, thanks for spotting it (I hadn't realized that it was skipped in the GA, I fixed that too).

I had asked earlier regarding the warning:

There's currently one check warning, namely the use of calls like: BSgenome.Hsapiens.UCSC.hg38:::BSgenome.Hsapiens.UCSC.hg38 The idea is to make building the annotation easy, but not require a systematic installation of those genome packages, since a user might just need one of them (or none). The error message when it's not installed is pretty clear... but if you have better suggestions about how to proceed with this kind of issue, we're all ears! Thanks in advance, PL

I know Suggests is supposed to be for that, but in practice R tries to install those packages as well, so I haven't found a better solution to this general problem. scDblFinder has the same warning because the mbkmeans dependency was not necessary (just speed-up) and creating installation troubles on some systems. There I wanted to use it if it's available, and use kmeans otherwise. How would one proceed to avoid warnings as well as having these in the imports? (Checking now in case something like requireNamespace would pass the checks...)

vjcitn commented 2 years ago

You don't need :::. :: is sufficient. Maybe that is not the concern you are asking about. You can put the Bsgenome.* packages in Suggests. Then a pattern like

if (!requireNamespace("BSgenome.Hsapiens.UCSC.hg19"))
  stop("Install BSgenome.Hsapiens.UCSC.hg19 with BiocManager to use this function.")

can be used when the usage requires it; if the package is installed then :: will get what user needs.

vjcitn commented 2 years ago

The master branch of your GitHub repository has been added to Bioconductor's git repository.

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/plger.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("scanMiRApp"). The package 'landing page' will be created at

https://bioconductor.org/packages/scanMiRApp

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.