Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

panelcn.mops #481

Closed gpovysil closed 7 years ago

gpovysil commented 7 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 help with submitting your package, please subscribe and post questions to the bioc-devel mailing list.

bioc-issue-bot commented 7 years ago

Hi @gpovysil

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: panelcn.mops
Type: Package
Title: CNV detection tool for targeted NGS panel data
Version: 0.99.0
Date: 2017-09-12
Author: Verena Haunschmid, Gundula Povysil
Maintainer: Gundula Povysil <povysil@bioinf.jku.at>
Description: CNV detection tool for targeted NGS panel data. 
    Extension of the cn.mops package.
License: LGPL (>= 2.0)
LazyData: TRUE
Imports: GenomicRanges, Rsamtools, IRanges, S4Vectors, GenomeInfoDb, grDevices
Depends: R (>= 3.4), cn.mops, methods, utils, stats, graphics
biocViews: Sequencing, CopyNumberVariation, CellBiology, GenomicVariation, VariantDetection, Genetics
RoxygenNote: 6.0.1
NeedsCompilation: no
Suggests: knitr,
    rmarkdown
VignetteBuilder: knitr
bioc-issue-bot commented 7 years ago

Your package has been approved for building. Your package is now submitted to our queue.

IMPORTANT: Please read the instructions for setting up a push hook on your repository, or further changes to your repository will NOT trigger a new build.

bioc-issue-bot commented 7 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 following build report for more details:

http://bioconductor.org/spb_reports/panelcn.mops_buildreport_20170914134113.html

lshep commented 7 years ago

Hello, Thank you for your interest in submitting to Bioconductor. Some comments and questions to be addressed:

Build report:

Vignette:

MAN:

R CODE:

Please update the package, ensure you have your webhook set up to get new build reports on version bumps, and comment back here with how the above have been addressed or clarification to questions. We look forward to getting your package accepted into Bioconductor.

Cheers, Lori

bioc-issue-bot commented 7 years ago

Received a valid push; starting a build. Commits are:

0caf95b changed version number Signed-off-by: gpovysil <g...

bioc-issue-bot commented 7 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: "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 following build report for more details:

http://bioconductor.org/spb_reports/panelcn.mops_buildreport_20170925092856.html

bioc-issue-bot commented 7 years ago

Received a valid push; starting a build. Commits are:

a4e66e5 removed pdf to prevent build warning Signed-off-b...

gpovysil commented 7 years ago

Dear Lori,

thanks for your comments. I included most of your suggestions in the new version of the package as you can see below:

Build report: 1) unit test were added Vignette: 1) I removed the bam file prior to submitting to Bioconductor because it was too large. I included now a statement in the vignette that this code should not be run and also adapted the example in the man page. Additionally I moved the loading of the data to the beginning of the vignette. 2) All acronyms are now defined at first occurrence. 3) selectedGenes is now defined in chapter 4 with the rest of the object used for the resulttable example. 4) Since both XandCB and countWindows can be fairly large objects and are reused for different resultlist objects I would prefer not to store them in the resultlist objects. 5) intergerCopyNumber is a function of the cn.mops package and only takes individual objects of the S4 class CNVDetectionResult as input. To make everything analogous to cn.mops I would prefer to use plotBoxplot the same way. Additionally the subsetting only has to be done once and plots for different genes can be created, otherwise the user would always have to input 2 parameters. 6) Thank you for pointing out that a new file gets created when compiling the vignette. I set the evaluation of the code to false because in my opinion using a temporary directory might confuse the user. I hope that’s ok.

MAN: 1) I included detailed descriptions and examples for the data man pages 2) Thanks for pointing out that the descriptions were missing for panelcn.mops and runPanelcnMops, I added them. 3) Originally I had more than one file in the extdata folder. I changed it now to system.file("extdata/Genes_part.bed", package = "panelcn.mops")

INST/EXTDATA 1) This is the BED file that defines the windows. I do not understand how I should create a man page for it since I could not find any package that has created man pages for data stored in extdata. Could you point me to an existing package with such a man page?

R CODE: 1) I totally understand your concern. However, the analogous function in the cn.mops package is called cn.mops, therefore I’m afraid users of cn.mops would be confused if we changed it to camelcase or underscore for panelcn.mops. 2) a) Thanks for pointing that out, I was not aware of the functions. I changed everything accordingly. b) Which for loops do you mean?

Again thanks for your efforts!

bioc-issue-bot commented 7 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: "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 following build report for more details:

http://bioconductor.org/spb_reports/panelcn.mops_buildreport_20170925101052.html

bioc-issue-bot commented 7 years ago

Received a valid push; starting a build. Commits are:

7f52b22 removed file to prevent warning Signed-off-by: Gu...

bioc-issue-bot commented 7 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 following build report for more details:

http://bioconductor.org/spb_reports/panelcn.mops_buildreport_20170925103645.html

lshep commented 7 years ago

Thank you for your updates and comments. I recognize the desire to be consistent with cn.mops and in this case will allow.

A few minor things: Vignette: There is a small typo where you define ROI resion -> region Thank you for including the BAM file not included this section isn't run. Could you also just add that you provided the test object as part of the data. inst/extdata: We like to ensure that data provided is freely available and reproducible with generally some information on how it was generated. Since this file is used as more of a generalized example and depicts proper format, I agree documentation isn't necessary. (although still encouraged to include a brief note on how it was generated in vignette or man page but not necessary) R code Any of the for loops. I'm not completely familiar with your code so I don't know off hand if it is possible to predetermine the lengths of the vectors that are being populated rather than the 'copy-and-append" approach. If it is possible, it is more efficient and saved memory. See section ‘Pre-allocate and fill’ if iterations are necessary. It may not be possible with your code but I wanted to mention it for review and as good practice.

Please do another version bump and comment when the typos are corrected.

Cheers, Lori

bioc-issue-bot commented 7 years ago

Received a valid push; starting a build. Commits are:

7f5bf65 fixed typo and added data description to vignette ...

gpovysil commented 7 years ago

I fixed the typo and added statements about the test object and BED file to the vignette.

Thanks again for your suggestions, I will keep them in mind for future projects.

bioc-issue-bot commented 7 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 following build report for more details:

http://bioconductor.org/spb_reports/panelcn.mops_buildreport_20170928020047.html

bioc-issue-bot commented 7 years ago

Your package has been accepted. It will be added to the Bioconductor Git repository and nightly builds. Additional information will be sent to the maintainer email address in the next several days.

Thank you for contributing to Bioconductor!

mtmorgan commented 7 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/gpovysil.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 biocLite(\"panelcn.mops\"). The package 'landing page' will be created at

https://bioconductor.org/packages/panelcn.mops

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.