Bioconductor / Contributions

Contribute Packages to Bioconductor
131 stars 33 forks source link

zitools submission #3094

Closed cmeyring closed 1 month ago

cmeyring 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]'

Justification for one warning: set.seed is used when randomly dividing a matrix into smaller blocks to ensure a reproducible process.

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

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: zitools
Title: Analysis of zero-inflated count data 
Version: 0.99.0
Authors@R: 
    person("Carlotta", "Meyring", , "carlotta.meyring@uniklinik-freiburg.de", role = c("aut", "cre"),
 comment = c(ORCID = "0009-0000-6201-7615"))
Description:
  zitools allows for zero inflated count data analysis by either using 
  down-weighting of excess zeros or by replacing an appropriate proportion of 
  excess zeros with NA. Through overloading frequently used statistical 
  functions (such as mean, median, standard deviation), plotting functions 
  (such as boxplots or heatmap) or differential abundance tests, it allows a 
  wide range of downstream analyses for zero-inflated data in a less biased 
  manner.
License: BSD_3_clause + file LICENSE
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
Imports: phyloseq,
pscl, 
ggplot2,
MatrixGenerics,
SummarizedExperiment,
stats, 
VGAM, 
matrixStats, 
tidyr,
tibble,
dplyr,
DESeq2,
reshape2, 
RColorBrewer,
magrittr, 
BiocGenerics,
graphics,
utils
Suggests: 
    knitr,
    rmarkdown,
    BiocStyle,
    testthat (>= 3.0.0), 
    tidyverse
Config/testthat/edition: 3
Collate: 
    'data.R'
    'globals.R'
    'ziMain.R'
    'helper.R'
    'inherited_functions.R'
    'plots.R'
    'utils.R'
Depends: R (>= 4.3.0), 
methods
VignetteBuilder: knitr
biocViews: Software, StatisticalMethod
LazyData: true
vjcitn commented 11 months ago

THanks for your submission. There's a lot going on here that should be remedied before review. First, I saw

Running the tests in 'tests/testthat.R' failed.
Last 13 lines of output:
  ══ Failed tests ════════════════════════════════════════════════════════════════
  ── Failure ('test-weights.R:27:5'): Compare results for sd, mean, rowMeans2 and colMeans2 on Zi object with weights equal to 1 to the case where Zi@inputcounts is used ──
  unname(rowMeans2(ZiW1)) (`actual`) not identical to rowMeans2(ZiW1@inputcounts) (`expected`).

  `names(actual)` is absent
  `names(expected)` is a character vector ('1', '2', '3', '4', '5', ...)
  ── Failure ('test-weights.R:28:5'): Compare results for sd, mean, rowMeans2 and colMeans2 on Zi object with weights equal to 1 to the case where Zi@inputcounts is used ──
  unname(colMeans2(ZiW1)) (`actual`) not identical to colMeans2(ZiW1@inputcounts) (`expected`).

  `names(actual)` is absent
  `names(expected)` is a character vector ('1', '2', '3', '4', '5', ...)

  [ FAIL 2 | WARN 0 | SKIP 0 | PASS 7 ]
  Error: Test failures
  Execution halted
* checking for unstated dependencies in vignettes ... OK
* checking package vignettes in 'inst/doc' ... OK
* checking running R code from vignettes ... NONE
  'my-vignette.Rmd' using 'UTF-8'... OK

and that should be corrected. Additionally, don't call your vignette "my-vignette.Rmd". Please use a package-oriented name. There is a download.file in the vignette, but the file is in the github repo and is small so it could just be placed in /data. In general we don't have downloads to working folder but ask that developers put retrieved artifacts in BiocFileCache, and the retrieval needs to be from a durable source, possibly ExperimentHub. There should be no .Rproj file in the submitted repo.

vjcitn commented 10 months ago

hi do u plan on revising?

cmeyring commented 10 months ago

Hi, yes I’ll revise beginning from next week. Von meinem iPhone gesendetAm 12.09.2023 um 20:41 schrieb Vince Carey @.***>: hi do u plan on revising?

—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: @.***>

cmeyring commented 10 months ago

Hello Vince,

thanks for the comment. I've updated the submitted repository, but I still have two questions: When I am running the tests of the package I don't get a error message. What command did you use to run the tests? And for the download.file, it is a dataset from another working group. I am probably not allowed to store the file in data, right? Therefore, I added the download.file.

Thanks in advance

vjcitn commented 10 months ago

I am working with the checkout

(base) %vjc> cd zitools
(base) %vjc> git log
commit fef06599d56709e7676c02a761926c9a051fdd52 (HEAD -> main, origin/main, origin/HEAD)
Author: cmeyring <carlotta-meyring@web.de>
Date:   Mon Sep 18 11:46:53 2023 +0200

    remove .Rproj

I am using

R version 4.3.1 Patched (2023-08-27 r85021) -- "Beagle Scouts"
Copyright (C) 2023 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

I get

  Running ‘testthat.R’
 ERROR
Running the tests in 'tests/testthat.R' failed.
Last 13 lines of output:
  ══ Failed tests ════════════════════════════════════════════════════════════════
  ── Failure ('test-weights.R:27:5'): Compare results for sd, mean, rowMeans2 and colMeans2 on Zi object with weights equal to 1 to the case where Zi@inputcounts is used ──
  unname(rowMeans2(ZiW1)) (`actual`) not identical to rowMeans2(ZiW1@inputcounts) (`expected`).

  `names(actual)` is absent
  `names(expected)` is a character vector ('1', '2', '3', '4', '5', ...)
  ── Failure ('test-weights.R:28:5'): Compare results for sd, mean, rowMeans2 and colMeans2 on Zi object with weights equal to 1 to the case where Zi@inputcounts is used ──
  unname(colMeans2(ZiW1)) (`actual`) not identical to colMeans2(ZiW1@inputcounts) (`expected`).

  `names(actual)` is absent
  `names(expected)` is a character vector ('1', '2', '3', '4', '5', ...)

  [ FAIL 2 | WARN 0 | SKIP 0 | PASS 7 ]
  Error: Test failures
  Execution halted
* checking for unstated dependencies in vignettes ... OK
* checking package vignettes in 'inst/doc' ... OK
* checking running R code from vignettes ...
  'zitools_tutorial.Rmd' using 'UTF-8'... OK
 NONE
* checking re-building of vignette outputs ... OK
* checking PDF version of manual ... OK
* DONE

Status: 1 ERROR, 1 NOTE

with R CMD build followed by R CMD check on

-rw-r--r--  1 vincent vincent   179407 Sep 30 23:41 zitools_0.99.0.tar.gz
cmeyring commented 9 months ago

Hello Vince,

the new version is pushed and I should work now.

lshep commented 9 months ago

There are still ERROR when we run this. Please run R CMD check with the most recent version of R and updated versions of Bioconductor packages

  Running ‘testthat.R’
 ERROR
Running the tests in 'tests/testthat.R' failed.
Last 13 lines of output:
  ══ Failed tests ════════════════════════════════════════════════════════════════
  ── Failure ('test-weights.R:27:5'): Compare results for sd, mean, rowMeans2 and colMeans2 on Zi object with weights equal to 1 to the case where Zi@inputcounts is used ──
  unname(rowMeans2(ZiW1)) (`actual`) not equal to rowMeans2(ZiW1@inputcounts) (`expected`).

  `names(actual)` is absent
  `names(expected)` is a character vector ('1', '2', '3', '4', '5', ...)
  ── Failure ('test-weights.R:28:5'): Compare results for sd, mean, rowMeans2 and colMeans2 on Zi object with weights equal to 1 to the case where Zi@inputcounts is used ──
  unname(colMeans2(ZiW1)) (`actual`) not equal to colMeans2(ZiW1@inputcounts) (`expected`).

  `names(actual)` is absent
  `names(expected)` is a character vector ('1', '2', '3', '4', '5', ...)

  [ FAIL 2 | WARN 0 | SKIP 0 | PASS 7 ]
  Error: Test failures
  Execution halted
lshep commented 9 months ago

You also cannot store data on github or personal spaces like dropbox. Example data for vignettes, man pages, and tests should be included with the package and/or using the ExperimentHub.

lshep commented 8 months ago

@cmeyring any update?

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

cmeyring commented 4 months ago

Hello, is it possible to reopen this issue? I was in between Master Thesis, PhD stages, and therefore, didn't have the time to adress the issues. However they are adressed now and I would like to reopen the issue, if that is possible.

Thanks in advance

lshep commented 4 months ago

Before this submission moves on in the review process:

cmeyring commented 4 months ago

Everything should be fine now, R CMD build and check run without any errors and Warnings. BiocCheck also runs without any errors, however one warning occurrs to a set.seed usage which is needed in that particular function. However, at the end of the function the seed is reset to its old random seed.

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

cmeyring commented 4 months ago

The Warning when running BiocCheck is due to the usage of set.seed. However, it is needed when randomly dividing a matrix into smaller blocks to ensure a reproducible process. After the usage of the function, the seed is set back to its old seed before.

bioc-issue-bot commented 4 months ago

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

Kayla-Morrell commented 3 months ago

@cmeyring - Thank you for submitting to Bioconductor. Please see the initial review of the package below. The required changes must be made while the suggested changes do not have to be (though we strongly encourage them). Comment back here with updates that have been made and when the package is ready for a re-review.

General package development

DESCRIPTION

NAMESPACE

NEWS

CITATION

Vignette

Man pages

R code

Best, Kayla

bioc-issue-bot commented 3 months ago

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

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: "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): zitools_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/zitools 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: 859a17096bdc3bcecef4ebe296b4a845ae6ffc32

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: "WARNINGS, skipped, 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): zitools_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/zitools to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

cmeyring commented 3 months ago

Hey Kayla, thank you for the comments. I pushed the updated package. However, there is an error when building on MacOS. I think this might be because there is not yet R.4.4 on merida1 (macOS) and therefore the R CMD build fails, as R.4.4 is required for the package.

I further adressed all the comments. However, I couldn't adress all, as stated below.

adding importFrom("stats", "predict") is not working because the predict function is used from the pscl package and as I understood it is nor correctly defined as a method for the generic function stats::predict

The suppressed warnings message is used in the ziMain function because the class of the count matrix of the phyloseq object is an otu_table, however we extract the count matrix and define it as a matrix which is perfectly fine at that step, however, it will produce a warning and therefore, we decided to supress the warning as we only need the count matrix of the class matrix.

Best, Carlotta

bioc-issue-bot commented 3 months ago

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

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: "WARNINGS, skipped, 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): zitools_0.99.3.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/zitools to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

lshep commented 3 months ago

merida1 was run in error -- please ignore the error in the build report and proceed with the clean build displayed on linux

Kayla-Morrell commented 1 month ago

@cmeyring - Thank you for making the necessary changes. I have looked everything over and it all looks good. I'm more than happy to accept the package.

Best, Kayla

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

https://bioconductor.org/packages/zitools

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.