Bioconductor / Contributions

Contribute Packages to Bioconductor
131 stars 33 forks source link

plasmut package submission #3127

Closed aditharun closed 9 months ago

aditharun commented 10 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 10 months ago

Hi @aditharun

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: plasmut
Type: Package
Title: Stratifying mutations observed in cell-free DNA and white blood cells as germline, hematopoietic, or somatic
Version: 0.99.0
Authors@R:
  c(person(given = "Adith",
 family = "Arun",
 role = c("aut", "cre"),
 email = "adith.3.arun@gmail.com"),
    person(given = "Robert",
 family = "Scharpf",
 role = "aut"))
Description: A Bayesian method for quantifying the liklihood that a given plasma mutation arises from clonal hematopoesis or the underlying tumor. It requires sequencing data of the mutation in plasma and white blood cells with the number of distinct and mutant reads in both tissues. We implement a Monte Carlo importance sampling method to assess the likelihood that a mutation arises from the tumor relative to non-tumor origin.
License: Artistic-2.0
Encoding: UTF-8
biocViews: Bayesian, SomaticMutation, GermlineMutation, Sequencing
RoxygenNote: 7.2.3
Imports:
    tibble,
    stats,
    dplyr
Depends:
    R (>= 4.1.0)
Suggests:
    knitr,
    rmarkdown,
    tidyverse,
    ggrepel,
    magrittr,
    qpdf,
    BiocStyle,
    biocViews,
    testthat (>= 3.0.0)
VignetteBuilder: knitr
Config/testthat/edition: 3
bioc-issue-bot commented 10 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 10 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.

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 Bioconductor Build System: macOS 12.6.5 Monterey: plasmut_0.99.0.tar.gz Linux (Ubuntu 22.04.2 LTS): plasmut_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/plasmut to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 10 months ago

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

aditharun commented 10 months ago

Hi @Kayla-Morrell , the one error in the build report was the BiocCheckGitClone() where some . files were being tracked. I updated the .gitignore and reran BiocCheckGitClone() and it now passes. Please let me know if there is anything else to be done for approval!

Kayla-Morrell commented 9 months ago

@aditharun - You need to push a version bump with these changes in order to kick off another build. See our documentation here for pushing upstream. Without a clean build report I can not move forward with my initial review.

Best, Kayla

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 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): plasmut_0.99.1.tar.gz macOS 12.6.5 Monterey: plasmut_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/plasmut to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

Kayla-Morrell commented 9 months ago

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

NEWS

Data

Vignette

Man pages

R code

Best, Kayla

aditharun commented 9 months ago

Hi @Kayla-Morrell, all of the required updates have been made! Thanks!

Kayla-Morrell commented 9 months ago

@aditharun - You need to push these changes with a valid version bump so a new build can be triggered, as I mentioned previously.

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 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): plasmut_0.99.3.tar.gz macOS 12.6.5 Monterey: plasmut_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/plasmut to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

aditharun commented 9 months ago

Hi @Kayla-Morrell, pushed off a new build - looking forward to your decision. Thanks!

Kayla-Morrell commented 9 months ago

@aditharun - Thank you for making those changes. There are two points above that were not addressed. Please address these issues and then I'll be happy to accept the package.

NEWS

Data

Best, Kayla

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 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): plasmut_0.99.5.tar.gz macOS 12.6.5 Monterey: plasmut_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/plasmut to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

aditharun commented 9 months ago

Hi @Kayla-Morrell - I believe the news file is properly formatted now and I added a description to data.R for the matched-sequencing file. Please let me know if that is an appropriate way to add this description or if there is a better way?

Kayla-Morrell commented 9 months ago

@aditharun - The news file looks good now. Since the matched-sequencing file is in the 'inst/extdata/' directory, the documentation should not be in a man page but in the 'inst/script/' directory instead. I would suggest taking the description you added to data.R and put it in a text file within 'inst/script/'. That should take care of the requirement.

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 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): plasmut_0.99.7.tar.gz macOS 12.6.5 Monterey: plasmut_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/plasmut to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

aditharun commented 9 months ago

Hi @Kayla-Morrell, thanks! Just, updated with a txt file in inst/script!

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

https://bioconductor.org/packages/plasmut

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.