Bioconductor / Contributions

Contribute Packages to Bioconductor
131 stars 33 forks source link

bettr #3321

Closed csoneson closed 3 months ago

csoneson commented 4 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 4 months ago

Hi @csoneson

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: bettr
Title: A Better Way To Explore What Is Best
Version: 0.99.0
Date: 2024-02-16
Authors@R: 
    c(person("Federico", "Marini", 
   role = "aut", email = "marinif@uni-mainz.de", 
   comment = c(ORCID = '0000-0003-3252-7758')),
      person("Charlotte", "Soneson", 
   role = c("aut", "cre"), email ="charlottesoneson@gmail.com", 
   comment = c(ORCID = '0000-0003-3833-2169')))
Description: bettr provides a set of interactive visualization methods to 
    explore the results of a benchmarking study, where typically more than a 
    single performance measures are computed. The user can weight the 
    performance measures according to their preferences. Performance measures
    can also be grouped and aggregated according to additional annotations. 
License: MIT + file LICENSE
Encoding: UTF-8
Suggests: 
    knitr,
    rmarkdown,
    testthat (>= 3.0.0),
    BiocStyle
VignetteBuilder: knitr
RoxygenNote: 7.3.1
Roxygen: list(markdown = TRUE)
Imports: 
    dplyr (>= 1.0),
    tidyr,
    ggplot2 (>= 3.4.1),
    shiny (>= 1.6),
    tibble,
    ComplexHeatmap,
    bslib,
    rlang,
    circlize,
    stats,
    grid,
    methods,
    cowplot,
    Hmisc,
    sortable,
    shinyjqui,
    grDevices,
    scales,
    DT,
    SummarizedExperiment,
    S4Vectors
Config/testthat/edition: 3
biocViews: Visualization, ShinyApps, GUI
URL: https://github.com/federicomarini/bettr
BugReports: https://github.com/federicomarini/bettr/issues
csoneson commented 4 months ago

cc @federicomarini

bioc-issue-bot commented 3 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 3 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Single Package Builder.

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 Single Package Builder: Linux (Ubuntu 22.04.3 LTS): bettr_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/bettr to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 months ago

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

bioc-issue-bot commented 3 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Single Package Builder.

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 Single Package Builder: Linux (Ubuntu 22.04.3 LTS): bettr_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/bettr to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 months ago

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

lazappi commented 3 months ago

Hi @csoneson

Thanks for submitting bettr :tada:! Below is my review of your package. Please reply here if anything is unclear or needs any further explanation.

What next?

Please address the comments as best as you can. When you are ready for me to check the package again please reply to let me know with a summary of changes you have made or any other responses. You can use the "Quote reply" option in the ... menu on this comment to reply directly to my points below.

Luke

Review

I only have some minor comments:

bioc-issue-bot commented 3 months ago

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

bioc-issue-bot commented 3 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Single Package Builder.

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 Single Package Builder: Linux (Ubuntu 22.04.3 LTS): bettr_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/bettr to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

csoneson commented 3 months ago

@lazappi Thanks a lot for your review! Below are our responses. You can also see all the changes in this PR.

  • [x] Please add Bioconductor installation instructions to the README and vignette

Done.

  • [x] The vignette should have an Introduction section that includes motivation for inclusion in Bioconductor and comparison to any similar tools

We expanded the Introduction section to address this.

  • [x] It might be useful to show some of the preparation of the clustering data in the vignette. There is a small toy example of this but I'm not sure how helpful that will be for users to prepare real input.

We adapted this section of the vignette to start from a single csv file with metric information (which is probably the most likely starting point for users).

  • [x] Similar for the OECD example. I don't think people will be able to find the script without an actual link to it. Maybe you could make this into a second vignette or a live examples somewhere?

We added a link to the script on GitHub to the vignette section. The reason we didn't explicitly include the data in the package is that we were a bit uncertain of whether we were able to redistribute it in this form (but we somehow still wanted to mention it since their interface was the main inspiration for bettr).

  • [x] Please double check the Shiny guidelines. I think you are already following these but just in case (maybe the organisation part?).

We double-checked and believe we are following the relevant guidelines. All code is included in exported functions that can also be run (and are tested) outside the Shiny app. On the side, we are experimenting a bit with shinytest2, which works ok locally but somehow doesn't seem to translate well when we push to other platforms (e.g., GitHub Actions) 🤔 Thus, we haven't yet integrated it into the package.

lazappi commented 3 months ago

Thanks for the quick changes. Looks good to me, I will accept the package.

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

lazappi commented 3 months ago

Congratulations on getting {bettr} into Bioconductor 🎉! It can take a couple of days to be picked up by the build system but then the package should be available as part of Bioconductor devel and the next release.

jwokaty commented 3 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/csoneson.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("bettr"). The package 'landing page' will be created at

https://bioconductor.org/packages/bettr

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.