Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

HarmonizR #3037

Closed SimonSchlumbohm closed 1 year ago

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

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: HarmonizR
Title: Handles missing values and makes more data available
Version: 0.99.0
Authors@R: 
    c(person(given = "Simon",
   family = "Schlumbohm",
   role = c("aut", "cre"),
   email = "schlumbohm@hsu-hh.de"),
      person(given = "Julia",
   family = "Neumann",
   role = "aut"),
      person(given = "Philipp",
   family = "Neumann",
   role = "aut"))
Description: An implementation, which takes input data and makes it available
    for proper batch effect removal by ComBat or Limma. The implementation appropriately
    handles missing values by dissecting the input matrix into smaller matrices
    with sufficient data to feed the ComBat or limma algorithm. The adjusted 
    data is returned to the user as a rebuild matrix. The implementation is 
    meant to make as much data available as possible with minimal data loss.
Depends: R (>= 4.2.0)
License: GPL-3
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
biocViews: BatchEffect
Imports: 
    doParallel (>= 1.0.16),
    foreach (>= 1.5.1),
    janitor (>= 2.1.0),
    plyr (>= 1.8.6),
    sva (>= 3.36.0),
    seriation (>= 1.3.5),
    limma (>= 3.46.0)
Suggests: 
    knitr,
    rmarkdown,
    testthat (>= 3.0.0)
VignetteBuilder: knitr
Config/testthat/edition: 3
vjcitn commented 1 year ago

Interesting package. Have you considered the use of SummarizedExperiment or its derivates, or MultiAssayExperiment, for managing the combinations of phenotypes and assays that you are working with? This is a standard approach to dealing with multiple assays on multiple samples and we strongly encourage this approach.

SimonSchlumbohm commented 1 year ago

Dear @vjcitn ,

thank you for your comment on the submitted package. We included support for the S4 SummarizedExperiment data type within the HarmonizR package and updated documentation accordingly. HarmonizR will now parse and return S4 SummarizedExperiment data to support more fluent data pipelining.

A version-bump to 0.99.1 has been made according to Bioconductor guidelines.

With best regards

Simon Schlumbohm

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

ococrook commented 1 year ago

Hi @SimonSchlumbohm

I'm very sorry for the delay. I've been out of office for July. The package looks really good and it very clear to follow. Some trivial things before acceptance:

Best wishes, Olly

SimonSchlumbohm commented 1 year ago

Dear @ococrook

thank you for the response. The package has been modified in the following ways:

Sincerely

Simon Schlumbohm

ococrook commented 1 year ago

Brilliant, thank you Simon

bioc-issue-bot commented 1 year 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 1 year 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/SimonSchlumbohm.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("HarmonizR"). The package 'landing page' will be created at

https://bioconductor.org/packages/HarmonizR

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.

SimonSchlumbohm commented 1 year ago

@vjcitn @ococrook @lshep I would like to express a thank you from my side to everyone who has been involved in the process.

Sincerely

Simon Schlumbohm