Bioconductor / Contributions

Contribute Packages to Bioconductor
131 stars 33 forks source link

cypress #3272

Closed renlyly closed 3 months ago

renlyly commented 5 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 5 months ago

Hi @renlyly

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: cypress
Type: Package
Title: Cell-Type-Specific Power Assessment
Version: 0.99.0
Date: 2023-12-21
Authors@R: c(person("Shilin", "Yu", role = c("aut", "cre"),email = 
  "sy597@georgetown.edu",comment=c(ORCID="0000-0002-5494-1960")),
   person("Guanqun", "Meng", role = "aut",email = "gxm324@case.edu"),
   person("Wen", "Tang", role = "aut",email = "wxt175@case.edu"))
License: GPL-2 | GPL-3   
Depends: R(>= 4.3.0) 
Imports: stats, abind, sirt,  lubridate, MASS,  TOAST, e1071, tibble, 
  parallel, preprocessCore, SummarizedExperiment, TCA, PROPER, methods,dplyr, 
  utils, RColorBrewer, Biobase, graphics, edgeR,  BiocParallel
Suggests: knitr, rmarkdown,   MatrixGenerics, htmltools, RUnit, BiocGenerics
Collate:  AllClasses.R  CIBERSORT.R csRNA_seq_sim.R cypress_design.R 
 cypress_wrapper.R cypressEmbedded.R  metrics.R show_methods.R   PlotTDR.R
  TOAST_implement.R user.R util_datasim.R util_EST.R PlotFDC.R PlotPower.R 
biocViews: Software, GeneExpression, DataImport, RNASeq, Sequencing
Description: CYPRESS is an Cell Type specific power tool. This package aims to 
  perform power analysis for the cell type-specific data. It calculates FDR, 
  FDC,and power, under various study design parameters, including but not
  limited   to sample size, and effect size.  It takes the input of the 
  SummarizeExperimental(SE)object with observed mixture data (feature by 
  sample matrix), and the cell type mixture proportions (sample by cell type 
  matrix).  It can solve the cell type mixture proportions from the reference
  free panel from TOAST and conduct  tests to identify cell-type-specific 
  differential expression (csDE) genes.
Encoding: UTF-8
LazyData: FALSE
VignetteBuilder: knitr
URL: https://github.com/renlyly/cypress
BugReports: https://github.com/renlyly/cypress/issues
lshep commented 5 months ago

You should not be referencing biocLite.R. This is a very old way of installing Bioconductor packages that is no longer endorsed. Please use BiocManager.

renlyly commented 5 months ago

Dear Ishep, Following your advice, we have removed any comments that might have referenced bioLite, to avoid any confusion. Please take a moment to review the updated version.

renlyly commented 4 months ago

You should not be referencing biocLite.R. This is a very old way of installing Bioconductor packages that is no longer endorsed. Please use BiocManager.

Hi @lshep, We have removed any comments that might have referenced bioLite, to avoid any confusion.

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, 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): cypress_0.99.0.tar.gz macOS 12.7.1 Monterey: cypress_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/cypress to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 4 months ago

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

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): cypress_0.99.1.tar.gz macOS 12.7.1 Monterey: cypress_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/cypress to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 4 months ago

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

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: macOS 12.7.1 Monterey: cypress_0.99.2.tar.gz : cypress_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/cypress to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 4 months ago

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

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.

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: macOS 12.7.1 Monterey: cypress_0.99.3.tar.gz : cypress_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/cypress to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

renlyly commented 4 months ago

Hi @lshep, We have solved the error and warning in the latest version.

Thank you very much for your time and assistance.

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.

HelenaLC commented 4 months ago

misc

code

documentation

vignette

bioc-issue-bot commented 4 months ago

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

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.

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): cypress_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/cypress to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

HelenaLC commented 4 months ago

Just to note that I'm still seeing things that are missing from the points raised previously; please respond to the comments above when ready so I can get a feel for what's been addressed - thanks!

renlyly commented 4 months ago

Hi @HelenaLC,

I've sent a push on git.bioconductor.org to check the time-consuming aspects. I will notify you immediately once we have addressed all the points raised in the comments. Thank you very much for your time and assistance.

Shilin

bioc-issue-bot commented 4 months ago

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

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): cypress_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/cypress to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 4 months ago

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

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.

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): cypress_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/cypress to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 4 months ago

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

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): cypress_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/cypress 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: 493b2e25d833e5a97ceb075ca6c0765ab52c385f

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): cypress_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/cypress to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

renlyly commented 3 months ago

Hi @HelenaLC , we have addressed all your questions in our updated version. Please see below for a point-by-point response to your questions:

misc

in the DESCRIPTION, please update R version dependency from 4.3.0 to 4.4.0

Response: In our DESCRIPTION, we have set 'Depends: R(>= 4.3.0)'. We encountered a problem because the latest version of R for macOS, R 4.3.2 "Eye Holes", was released on 2023/10/31. If we update the dependency from 4.3.0 to 4.4.0, we will not be able to check our package.

I greatly encourage you to expand on unit tests (devtools::test_coverage() shows me only plotting functions are being tested at all right now; >85% of code is not)

Response: Thanks for the suggestion. We have exported a total of 6 functions: 3 plot functions, 2 simulation functions, and one quick power function. Currently, all six functions are being tested. code

I'd highly recommend implementing minimal validity checks on arguments when functions expect a specific type of input, e.g., argument 1 should be of class X with data A and B available, argument 2 should be a scalar integer etc. - these help avoid confusing errors to the user when a function fails downstream.

Response: Thanks for the suggestion. All 6 exported functions have been equipped with sufficient validity checks on arguments. Please review.

@ should never be used for data accession; for any exported classes, please implement respective generics and methods (see here for details)

Response: Thanks for pointing this out. Currently, our code does not use @ for data accession; we have adopted alternative methods instead. We also update the methods. The @ is only present in commented-out code.

Custom classes should at least come with a validity method that verifies slots are of appropriate format/structure/content etc.

Response: Thanks for the suggestion. We export two classes, both supplemented with a validity method. we have also added a .rd file for classes and methods.

related to these two previous comments; I don't quite see why implementing S4 classes that merely contain as series of numeric/characters/matrices/data.frames is the way to go here. I feel that either 1) there should be a more compact show method, appropriate accessor and replacement methods, validity methods etc. or 2) remove these classes and all associated code completely in favor of 3 helper functions that validate inputs/outputs are of the desired format (names and contents matching). In the context of this package, I feel that implementing classes properly provides more work than benefit; up to you! But if you chose 1), the Bioc guidelines for class developement need to be addressed.

Response: Thank you for your advice. We have now implemented a more compact show method. Both classes come with a validity method in Allclasses.R. The structure of the result is currently what our package expects

documentation

consider adding a package man page with an overview of the package and links to the main functions; users should be able to have a relevant page display with ?cypress

Response: Thanks for the suggestion. We have added a new package man page. We also added some details. Please review.

in the README, please add Bioc installation instructions using BiocManager::install()

Response: Thanks for the suggestion. This section has been added, please check.

data/ contains 7 .rds files, however, their documentation isn't findable directly except for 2 (those related to GSE60424); please add corresponding aliases (e.g., the asdPower.Rd should link to ?quickPowerIBD)

Response: Thanks for the suggestion. Now all rd files have been updated. The rd. files related to data are aliases to both dataset names and rda file names.

vignette

in the vignette, eval=FALSE flags are generally not permitted; I see 2 un-evaluated chunks (besides installation and loading the vignette) - please let these run, remove them, or (rarely applicable) justify why they cannot be evaluated (see here for details)

Response: Thanks for the suggestion. This issue has been addressed.

vignette writing: please have this proof-read for typos and grammar; I'm seeing a lot of mistakes that impede readability... e.g.,

Response: Thank you so much for the suggestion. We have made lots of revisions to the vignette content, including typos and grammar corrections. We have also reviewed the use of space requirements.

Shilin

HelenaLC commented 3 months ago
bioc-issue-bot commented 3 months ago

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

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): cypress_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/cypress 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: 3112c144d17c1c8a0296c65f40a76fd9e33aaa8d

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): cypress_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/cypress 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: 4cab0bdf2f66ac5060fea7b6dd8a51c6eb57f8a1

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: "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: ERROR before build products produced.

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/cypress 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: 936dfbe86a05897eaf62b67d84ff5750df10ebd2

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: "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: ERROR before build products produced.

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/cypress 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: 1f77cf7bc7a353af5c7cc0e33ef3d735a0a0ecf5

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): cypress_0.99.13.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/cypress 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: 7eea72d610d43b3e75047251659e1b068175b1bf

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: "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: ERROR before build products produced.

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/cypress 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: 334c3c3d9000b41aba7c363182f4adb2ecaae4e3

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): cypress_0.99.15.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/cypress to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

renlyly commented 3 months ago

Dear @HelenaLC ,

Thank you very much for your valuable suggestions. Here are the updates I’ve made based on your feedback:

  1. I have made modifications to the comments on the guidelines in section 15.2.7.3.
  2. The simFromData() function appears twice in the vignette. I’ve set eval=FALSE for its first occurrence at line 62+ to avoid lengthy processing times. The repetition of simulation and power evaluation is time-consuming. We set eval=TRUE in the latest version without any new warnings and errors.
  3. We decided to use \donttest{} for the same reason—repeated simulation and power evaluation takes a considerable amount of time, and we wish to prevent warnings related to execution times exceeding 10 minutes.
  4. I greatly appreciate your advice and examples concerning the S4 class. The new S4 class code should now meet the necessary requirements. Key updates include: I. Added accessor and replacement methods, with the required SetGenerics and rd. file. II. Updated the output functions to ensure there’s no use of slots or ‘@’ outside of accessor functions. III. Implemented validity checks for dimensions and names as required.

I hope these adjustments address your concerns satisfactorily. Best regards, Shilin

HelenaLC commented 3 months ago

Thanks for all this, getting real close I think... hopefully last round of comments:

bioc-issue-bot commented 3 months ago

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

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): cypress_0.99.16.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/cypress 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: 65260e797f6afbbacd58a5d61808ed2f49e9868d

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): cypress_0.99.17.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/cypress 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: 3c8ef7de9f097bcda0cd5925cee0a864f802a4ba