Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

CyTOFpower #2360

Closed FerreiraAM closed 3 years ago

FerreiraAM commented 3 years 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 3 years ago

Hi @FerreiraAM

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: CyTOFpower
Type: Package
Title: Power analysis for CyTOF experiments
Version: 0.99.0
Authors@R: c(person("Anne-Maud", "Ferreira",
 email = "anne-maud.ferreira@stanford.edu",
 role = c("cre", "aut"),
 comment = c(ORCID = "0000-0002-4749-746X")),
    person("Catherine", "Blish",
  email = "",
  role = c("aut")),
    person("Susan", "Holmes",
  email = "sph@stanford.edu",
  role = c("aut")))
Description: This package is a tool to predict the power of CyTOF 
    experiments, where differential state analyses are performed. The package provides 
    a shiny app with two of checking for the power: i. generation of in-sicilico CyTOF 
    data, using users input ii. browsing in a grid of parameters where the power was 
    already precomputed.
biocViews: FlowCytometry, SingleCell, CellBiology, StatisticalMethod, Software
License: LGPL-3
Encoding: UTF-8
Depends:
    R (>= 4.1)
Imports:
  CytoGLMM,
  diffcyt,
  DT,
  dplyr,
  ggplot2,
  magrittr,
  methods,
  rlang,
  stats,
  shiny,
  shinyFeedback,
  shinyjs,
  shinyMatrix,
  SummarizedExperiment,
  tibble,
  tidyr
RoxygenNote: 7.1.2
VignetteBuilder: knitr
Suggests: 
    testthat (>= 3.0.0),
    BiocStyle,
    knitr
Config/testthat/edition: 3
bioc-issue-bot commented 3 years 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 3 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

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. 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/CyTOFpower 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 years ago

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

bioc-issue-bot commented 3 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

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. 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/CyTOFpower 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 years ago

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

bioc-issue-bot commented 3 years 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/CyTOFpower 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 years ago

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

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

FerreiraAM commented 3 years ago

Dear Hervé, I updated the package by adding unit tests. I think that the package is ready for review. Please let me know if you any specific comments during the review process. Thank you so much for your time and feedback. Best regards.

hpages commented 3 years ago

Hi Anne-Maud,

The only function in your package that is exported and therefore visible to the end user is CyTOFpower(). Having dozens of man pages for internal functions is not necessary and can only confuse the end user e.g. when they look at the reference manual. There are usually 2 ways to handle this:

  1. Don't provide man pages for internal functions.
  2. Provide man pages for them but they need to contain \keyword(internal) so they don't get included in the reference manual of the package.

Also the sections in the vignette are strangely numbered: Screenshot from 2021-10-14 12-27-17

Other than that, the package is ready for acceptance.

Thanks, H.

bioc-issue-bot commented 3 years ago

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

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

FerreiraAM commented 3 years ago

Dear Hervé, Thank you for your review and feedback. I included the requested changes in the last update. Best regards, Anne-Maud

hpages commented 3 years ago

Hi Anne-Maud,

Thanks for the changes. Package is good to go.

Cheers, H.

bioc-issue-bot commented 3 years 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 3 years ago

The master branch of your GitHub repository has been added to Bioconductor's git repository.

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/FerreiraAM.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("CyTOFpower"). The package 'landing page' will be created at

https://bioconductor.org/packages/CyTOFpower

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.