Bioconductor / Contributions

Contribute Packages to Bioconductor
131 stars 33 forks source link

iSEEpathways #3133

Closed kevinrue closed 9 months ago

kevinrue commented 10 months 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 10 months ago

Hi @kevinrue

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: iSEEpathways
Title: iSEE extension for panels related to pathway analysis
Version: 0.99.0
Date: 2023-09-04
Authors@R: 
    c(person("Kevin", "Rue-Albrecht", email = "kevinrue67@gmail.com",
   role = c("aut", "cre"),
   comment = c(ORCID = "0000-0003-3899-3872")),
    person("Thomas", "Sandmann", email = "tomsing1@gmail.com",
   role = c("ctb"),
   comment = c(ORCID = "0000-0002-6601-8890")),
    person("Denali Therapeutics", role = c("fnd")))
Description: This package contains diverse functionality to extend the usage
    of the iSEE package, including additional classes for the panels or modes
    facilitating the analysis of pathway analysis results.
    This package does not perform pathway analysis. Instead, it provides methods
    to embed precomputed pathway analysis results in a SummarizedExperiment
    object, in a manner that is compatible with interactive visualisation
    in iSEE applications.
License: Artistic-2.0
URL: https://github.com/iSEE/iSEEpathways
BugReports: https://support.bioconductor.org/t/iSEEpathways
biocViews: Software,
    Infrastructure
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
Depends:
    iSEE
Imports:
    ggplot2,
    methods,
    S4Vectors,
    shiny,
    shinyWidgets,
    SummarizedExperiment
Suggests:
    airway,
    BiocStyle,
    covr,
    edgeR,
    fgsea,
    GO.db,
    iSEEde,
    knitr,
    org.Hs.eg.db,
    RefManageR,
    rmarkdown,
    scater,
    scuttle,
    sessioninfo,
    testthat (>= 3.0.0)
Config/testthat/edition: 3
VignetteBuilder: knitr
Remotes:
    iSEE/iSEEde
kevinrue commented 10 months ago

Watchers: @csoneson @federicomarini @LTLA @tomsing1

federicomarini commented 10 months ago

IIRC, we are not allowed to have the Remotes field populated in the description. But now that is probably not needed as iSEEde is already on Bioc?

kevinrue commented 10 months ago

Woopsidaisies. Missed that in my latest round of proofreading 😇

EDIT: fixed.

bioc-issue-bot commented 10 months 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 10 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): iSEEpathways_0.99.0.tar.gz macOS 12.6.5 Monterey: iSEEpathways_0.99.0.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/iSEEpathways to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 10 months ago

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

lshep commented 9 months ago

Description

Namespace

Vignette

federicomarini commented 9 months ago

Thanks @lshep for the review! We started working on your points in a dedicated branch (bioc_review), we will get back to you once we addressed them all.

kevinrue commented 9 months ago

Agree 💯 on all points.

1) Will add ShinyApps in the next version.

2) Yes the . methods need to be exported. We got away with this now a couple of times when submitting iSEE extensions, but I agree that those methods need to be renamed without .. It's a leftover from the early days of iSEE when those methods were internal. If you don't mind letting it slide one last time, I would like to tackle that deprecation/renaming in the next release cycle (Oct23-Apr24)

3) 'pathway' panels cannot yet transmit 'outgoing' selections due to how selections are implemented in iSEE (rows = genes, columns = samples). I've started discussing the implementation of such functionality with @LTLA , but that will require some careful refactoring in iSEE itself, which is definitely not going to happen before the next release cycle.

I look forward to your thoughts on points 2 and 3.

federicomarini commented 9 months ago

Yes the . methods need to be exported. We got away with this now a couple of times when submitting iSEE extensions, but I agree that those methods need to be renamed without .. It's a leftover from the early days of iSEE when those methods were internal. If you don't mind letting it slide one last time, I would like to tackle that deprecation/renaming in the next release cycle (Oct23-Apr24)

On this one: I am thinking of the "best alternative" on how to do that. Would a prefix in front of each function name be good enough? We are happy to comply with whatever best option is used in this or other ecosystems where that is also something one cannot escape.

lshep commented 9 months ago

as long as 3 is known and there is a valid explanation. Just was confused as generally there is interaction and customization in an app launched. 2. Yes we can let that '.' slide for now in favor of a future rename/deprecation. I think the immediate will be adding the biocView and you can be all set for now.

federicomarini commented 9 months ago

I think the immediate will be adding the biocView and you can be all set for now.

Perfect, PR is already on its way with that and a couple of other meaningful ones we missed in the first place. @kevinrue we just need to trigger the SPB, and we continue the renaming conversation on Slack 😉

kevinrue commented 9 months ago

I’ll merge and trigger the SPB tonight.

The rest is indeed an overdue discussion on slack :)

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 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: macOS 12.6.5 Monterey: iSEEpathways_0.99.1.tar.gz Linux (Ubuntu 22.04.2 LTS): iSEEpathways_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/iSEEpathways to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

kevinrue commented 9 months ago

Hold that thought. Still a bunch of WARNINGS that can be easily resolved before adding to BioC :)

kevinrue commented 9 months ago

github action in progress, locally BiocCheck says only 4 NOTES left, which I'm all happy with (line width, 4 space tabs, cannot check maintainer on mailing list, BiocViews).

When github action completes, I'll merge and push to the bioc remote to trigger the SPB.

Stay tuned :)

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 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): iSEEpathways_0.99.2.tar.gz macOS 12.6.5 Monterey: iSEEpathways_0.99.2.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/iSEEpathways to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 9 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 9 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/kevinrue.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("iSEEpathways"). The package 'landing page' will be created at

https://bioconductor.org/packages/iSEEpathways

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.