Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

PLSDAbatch #3009

Closed EvaYiwenWang closed 10 months ago

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

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: PLSDAbatch
Type: Package
Title: PLSDA-batch
Version: 0.99.0
Authors@R: 
    c(person(given = "Yiwen", family = "Wang", middle = "(Eva)", role = c("aut", "cre"), email = "anjiwangyiwen@gmail.com", comment=c(ORCID="0000-0002-7067-9093")),
      person(given = "Kim-Anh", family = "Le Cao", role = "aut", email = "kimanh.lecao@unimelb.edu.au"))
Description: A novel framework to correct for batch effects prior to any downstream analysis in microbiome data based on Projection to Latent Structures Discriminant Analysis. The main method is named “PLSDA-batch”. It first estimates treatment and batch variation with latent components, then subtracts batch-associated components from the data whilst preserving biological variation of interest. PLSDA-batch is highly suitable for microbiome data as it is non-parametric, multivariate and allows for ordination and data visualisation. Combined with centered log-ratio transformation for addressing uneven library sizes and compositional structure, PLSDA-batch addresses all characteristics of microbiome data that existing correction methods have ignored so far. Two other variants are proposed for 1/ unbalanced batch x treatment designs that are commonly encountered in studies with small sample sizes, and for 2/ selection of discriminative variables amongst treatment groups to avoid overfitting in classification problems. These two variants have widened the scope of applicability of PLSDA-batch to different data settings. 
License: GPL-3
Depends: 
    R (>= 4.3.0)
Imports: 
    mixOmics,
    scales,
    Rdpack,
    ggplot2,
    gridExtra,
    ggpubr,
    lmerTest,
    performance,
    grid,
    stats
Suggests: 
    BiocStyle,
    knitr,
    rmarkdown,
    vegan,
    testthat,
    Biobase,
    badger
biocViews:
    StatisticalMethod,
    DimensionReduction,
    PrincipalComponent,
    Classification,
    Microbiome,
    BatchEffect,
    Normalization, 
    Visualization
VignetteBuilder: knitr
RdMacros: Rdpack
RoxygenNote: 7.2.3
Encoding: UTF-8
BugReports: https://github.com/EvaYiwenWang/PLSDAbatch/issues/
vjcitn commented 1 year ago

Please check on a clean system

Quitting from lines 240-246 (brief_vignette.Rmd) 
Error: processing vignette 'brief_vignette.Rmd' failed with diagnostics:
could not find function "varpart"
--- failed re-building ‘brief_vignette.Rmd’
EvaYiwenWang commented 1 year ago

Hi vjcitn,

We fixed the error. Please check again. Many thanks.

Best regards, Eva

vjcitn commented 1 year ago

You will probably be advised to use a SummarizedExperiment derivate like TreeSummarizedExperiment to manage your multisample data.

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

LiNk-NY commented 1 year ago

Hi YiWen, @EvaYiwenWang

Thank you for your submission. Please see the review below.

Best regards, Marcel


PLSDAbatch #3009

DESCRIPTION

NAMESPACE

vignettes

R

tests

bioc-issue-bot commented 12 months ago

This issue is being closed because there has been no progress for an extended period of time. You may reopen the issue when you have the time to actively participate in the review / submission process. Please also keep in mind that a package accepted to Bioconductor requires a commitment on your part to ongoing maintenance.

Thank you for your interest in Bioconductor.

EvaYiwenWang commented 11 months ago

To whom it may concern,

We have updated our package accordingly. We are very sorry for the late updates and will maintain it promptly afterwards. Could you reopen the issue?

Best regards, Eva

bioc-issue-bot commented 11 months ago

Dear @EvaYiwenWang ,

We have reopened the issue to continue the review process. Please remember to push a version bump to git.bioconductor.org to trigger a new build.

bioc-issue-bot commented 11 months 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: 8f9f240f31fae109e1fb463f80fe2557f2eac447

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): PLSDAbatch_0.99.2.tar.gz macOS 12.6.5 Monterey: PLSDAbatch_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/PLSDAbatch to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

LiNk-NY commented 10 months ago

Hi YiWen, @EvaYiwenWang Could you please respond to the review? Thank you! Best, Marcel

EvaYiwenWang commented 10 months ago

Dear Marcel,

Many thanks for your message. Do I need to reply to the review one by one to see if I solved the problems? I have updated my package according to the suggestions you gave in your previous review. I may list them to you then.

Best regards, Eva

EvaYiwenWang commented 10 months ago

Dear Marcel,

Many thanks for your review and I am listing my answers as follows:

DESCRIPTION Add a URL field to point to the GitHub repository of the package. ----> I added a URL like this. URL: https://github.com/EvaYiwenWang/PLSDAbatch

NAMESPACE Looks good. -----> Thank you.

vignettes Consider wrapping text to a character limit of 80. -----> I tried to wrap as many texts as possible to the limit of 80. However, 10 lines are in the vignette code chunks which include the figure captions that I cannot shorten them. Example: {r ADpcaBefore, out.width = '80%', fig.align = 'center', fig.cap = 'The PCA sample plot with densities in the AD data.'}...

No need to use a vector of package names. You can simply use repeated library() calls. This is more common practice, i.e., remove the sapply calls and use library. ----> Done.

Please use a central representation such as TreeSummarizedExperiment to represent the data, e.g., AD_data. Otherwise, it would be hard for the user to follow all of the operations performed in the Pre-filtering section of the vignette. ----> I have reorganised the datasets with the package TreeSummarizedExperiment.

Consider using Biocpkg() and CRANpkg() instead of colorize. -----> I removed the home-made function colorize(). For different colors of text, I used $\color{blue}{\bf{\text{Anaerobic digestion.}}}$ instead.

R Consider using the 'allocate and fill' strategy for your for loops, e.g. in alignment_score. Use vector to create an empty vector with the same size as the expected output. ----> Done.

Remove extra ###* lines from R files. ----> Done.

Data documentation looks complete. ----> Thanks.

tests Package coverage looks good.

covr::package_coverage() PLSDAbatch Coverage: 75.35% R/plsda_batch.R: 66.67% R/managing_batch_effects.R: 67.35% R/batch_detection.R: 91.46% R/batch_assessment.R: 96.15% R/alignment_score.R: 100.00% R/data_preprocessing.R: 100.00% R/pb_color.R: 100.00% -----> Thanks.

Best regards, Eva

LiNk-NY commented 10 months ago

Hi YiWen, @EvaYiwenWang Thank you for the update on the review. Your package has been accepted. Best regards, Marcel

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

EvaYiwenWang commented 10 months ago

Many thanks, Marcel and the Bioconductor team!

Best regards, Eva

lshep commented 10 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/EvaYiwenWang.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("PLSDAbatch"). The package 'landing page' will be created at

https://bioconductor.org/packages/PLSDAbatch

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.