Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

limpca #3149

Closed ManonMartin closed 5 months ago

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

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: limpca
Type: Package
Title: An R package for the linear modeling of high-dimensional designed data based on ASCA/APCA family of methods
Version: 0.99.0
Authors@R: c(person("Bernadette", "Govaerts", role = c("aut", "ths"),
           email = "bernadette.govaerts@uclouvain.be"),
    person("Sebastien","Franceschini", role = "ctb",
          email="sfranceschini@uliege.be"),
    person("Robin","van Oirbeek", role = "ctb",
          email="robin.vanoirbeek@gmail.com"),
    person("Michel","Thiel", role = "aut",
          email="michel.thiel@uclouvain.be"),
    person("Pascal","de Tullio", role = "dtc",
          email="pdetullio@uliege.be"),
    person("Manon","Martin", role = c("aut", "cre"),
          email="manon.martin@uclouvain.be",
          comment = c(ORCID = "0000-0003-4800-0942")),
    person("Nadia", "Benaiche", role = "ctb",
           email = "nadia.benaiche@student.uclouvain.be"))
Description: >
 This package has for objectives to provide a method to make Linear Models 
 for high-dimensional designed data. limpca applies a GLM (General Linear Model) 
 version of ASCA and APCA to analyse multivariate sample profiles generated 
 by an experimental design. ASCA/APCA provide powerful visualization 
 tools for multivariate structures in the space of each effect of 
 the statistical model linked to the experimental design and contrarily 
 to MANOVA, it can deal with mutlivariate datasets having more variables 
 than observations. This method can handle unbalanced design.
License: Artistic-2.0
Encoding: UTF-8
LazyData: FALSE
VignetteBuilder: knitr
Imports: ggplot2, stringr, plyr, ggrepel, reshape2,
    grDevices, graphics, doParallel, parallel, dplyr, tibble, tidyr, ggsci,
    tidyverse, methods, stats
Suggests: 
    BiocStyle, pander, 
    rmarkdown, car, gridExtra, knitr
biocViews: StatisticalMethod, PrincipalComponent, Regression, Visualization, ExperimentalDesign, MultipleComparison
RoxygenNote: 7.2.3
Roxygen: list(markdown=TRUE)
BugReports: https://github.com/ManonMartin/limpca/issues
URL: https://github.com/ManonMartin/limpca,
    https://manonmartin.github.io/limpca/
bioc-issue-bot commented 1 year 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 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.

On one or more platforms, the build results were: "WARNINGS, 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 Bioconductor Build System: macOS 12.6.5 Monterey: limpca_0.99.0.tar.gz Linux (Ubuntu 22.04.2 LTS): limpca_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/limpca to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

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.

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

ManonMartin commented 1 year ago

The remaining warning is due to missing values field in 3 man pages (man/limpca.Rd, man/trout.Rd, man/UCH.Rd), but they concern data or package description, so in my opinion no value field is necessary.

lshep commented 12 months ago

Could you please provide an abstract/intro section in your vignette that provides motivation for inclusion in Bioconductor and when appropriate a review and comparison to existing Bioconductor packages with similar functionality or scope

vjcitn commented 11 months ago

@ManonMartin please update?

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

bioc-issue-bot commented 7 months ago

Dear @ManonMartin ,

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 7 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 7 months ago

cannot build unless issue is open and has the 'pre-review' label or '2. review in progress' label, or is closed and has the 'TESTING' label.

ManonMartin commented 7 months ago

Could you please provide an abstract/intro section in your vignette that provides motivation for inclusion in Bioconductor and when appropriate a review and comparison to existing Bioconductor packages with similar functionality or scope

Sorry for the extended time taken to reply. The introduction of the UCH vignette has been modified accordingly to motivate the inclusion of limpca to Bioconductor.

bioc-issue-bot commented 7 months ago

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

bioc-issue-bot commented 7 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: "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 Single Package Builder: Linux (Ubuntu 22.04.3 LTS): limpca_0.99.4.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/limpca to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

lshep commented 7 months ago

Before a reviewer is assigned for an in-depth review of the package, please see the following comments:

Build Report

NEWS

ie:

# limpca 0.0.99

 - submitted to bioconductor

Citation File

> readCitationFile("CITATION")
Error in tools:::.parse_CITATION_file(file, meta$Encoding) : 
  non-ASCII input in a CITATION file without a declared encoding
> 

General

bioc-issue-bot commented 6 months ago

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

bioc-issue-bot commented 6 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: "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 Single Package Builder: Linux (Ubuntu 22.04.3 LTS): limpca_0.99.5.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/limpca to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

ManonMartin commented 6 months ago

Hi, thank you for these remarks. there is the progress so far:

# Not working 
utils::readCitationFile("inst/CITATION")

# Working
utils::readCitationFile("inst/CITATION", meta = packageDescription("limpca",  encoding = NA))
lshep commented 6 months ago

Please let us know when you have incorporated interoperability.

bioc-issue-bot commented 6 months ago

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

bioc-issue-bot commented 6 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: "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 Single Package Builder: Linux (Ubuntu 22.04.3 LTS): limpca_0.99.6.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/limpca to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

ManonMartin commented 6 months ago

Hi, interoperability has been added trough the function data2LmpDataList: it can convert a SummarizedExperiment to a list (lmpDataList) formatted to run the core functions of the package.

lshep commented 6 months ago

Likely the Citation file will not display correctly on the package landing page. We use default setting when extracting and it is currently not possible to customize.

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

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

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

hpages commented 5 months ago

Thanks @ManonMartin for submitting limpca to Bioconductor.

A quick note before I take a closer look at the package: Bioconductor packages should always be installed with BiocManager::install() (see for example https://bioconductor.org/packages/release/bioc/html/BiocIO.html). So the Installation section in the vignette should have something like this in an non-evaluated (eval=FALSE) code chunk:

```{r installation, eval=FALSE}
if (!require("BiocManager", quietly=TRUE))
    install.packages("BiocManager")
BiocManager::install("limpca")
```

Also please keep in mind that we strongly advice against installing packages directly from GitHub as it tends to mix up package versions that belong to different versions of Bioconductor, which usually doesn't end well.

Thanks, H.

ManonMartin commented 5 months ago

Thank you for the preliminary note. Should I already update the installation instructions if the package is not (yet) on Bioconductor? Of course if the package is accepted, I will completely remove the GitHub installation instructions.

hpages commented 5 months ago

Yes please. We expect that issues reported during the review process get addressed before the package can be accepted. Thanks for your understanding.

bioc-issue-bot commented 5 months ago

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

ManonMartin commented 5 months ago

Thanks for the comment, this is now fixed.

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

hpages commented 5 months ago

Thanks for making that change.

Package looks good. Only some minor cosmetic issues:

Please address as soon as possible so we can include the package in BioC 3.19.

Thanks, H.

hpages commented 5 months ago

I see that you wrote the following comment above in response to a request from @vjcitn:

The introduction of the UCH vignette has been modified accordingly to motivate the inclusion of limpca to Bioconductor.

I think a better place for this is the "Get started with limpca" vignette since this is where your users will start reading. I don't think the introduction needs to explain the motivation for inclusion to Bioconductor, but it needs to explain what the package is about and what's its "raison d'être".

Oh, and also please remove > from the Description field of your DESCRIPTION fie.

Thanks again, H.

bioc-issue-bot commented 5 months ago

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

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

bioc-issue-bot commented 5 months ago

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

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

ManonMartin commented 5 months ago

Thanks for the comments. I addressed them for the vignettes as well as the > from the Description.

Vignettes modifications:

hpages commented 5 months ago

Changes look good. Thanks!

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

https://bioconductor.org/packages/limpca

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.