Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

BOBaFIT package #2345

Closed bioinformatic-seragnoli closed 2 years ago

bioinformatic-seragnoli 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 @bioinformatic-seragnoli

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: BOBaFIT
Type: Package
Title: Refitting diploid region profiles using a clustering procedure
Version: 0.99.0
Authors@R: c(person("Andrea", "Poletti", email="andrea.poletti5@gmail.com", role=c("aut")),
      person("Gaia", "Mazzocchetti", email="bioinformatic.seragnoli@gmail.com", role=c("aut", "cre")),
      person("Vincenza", "Solli", email="vincenza.solli2@unibo.it", role=c("aut")))
Description: This package provides a method to refit and correct the diploid region in copy number profiles. It uses a clustering algorithm to 
 identify pathology-specific normal (diploid) chromosomes and then use their copy number signal to refit the whole profile. 
 The package is composed by three functions: DRrefit (the main function), ComputeNormalChromosome and PlotCluster. 
License: GPL (>= 3)
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.1.1
URL: https://github.com/andrea-poletti-unibo/BOBaFIT
BugReports: https://github.com/andrea-poletti-unibo/BOBaFIT/issues
Imports: 
    dplyr (>= 1.0.6),
    NbClust (>= 3.0),
    ggplot2 (>= 3.3.3),
    ggbio (>= 1.38.0),
    grDevices,
    stats,
    tidyr (>= 1.1.3),
    GenomicRanges (>= 1.42.0),
    ggforce (>= 0.3.3),
    stringr (>= 1.4.0)
Suggests: 
    rmarkdown (>= 2.8),
    markdown (>= 1.1),
    BiocStyle (>= 2.18.1),
    knitr (>= 1.33),
    testthat (>= 3.0.0),
    utils
Config/testthat/edition: 3
biocViews: CopyNumberVariation, Clustering, Visualization, Normalization, Software
Depends: 
    R (>= 4.0)
VignetteBuilder: knitr
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: "ABNORMAL". 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/BOBaFIT 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: 139bb8a7a65640b0d0526b35ba3229b5234cb8fc

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/BOBaFIT 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: 5cd972efec3afabf38ddf89761d48483ec4aa107

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/BOBaFIT 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: 32b865070e7d5f9ace1bc16c010a4582c0035679

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

LiNk-NY commented 3 years ago

Hi Gaia, @bioinformatic-seragnoli

Thank you for your submission. Please see the review below.

Best regards, Marcel


BOBaFIT #2345

DESCRIPTION

NAMESPACE

vignettes

R

tests

/

LiNk-NY commented 3 years ago

Close due to inactivity.

bioinformatic-seragnoli commented 3 years ago

Sorry if we took a long time to answer, but we still are working on the comments received. Is it possible to reopen our submission issue? We did a lot of work and we are going to push our last updates in a few days. Sorry again for the inactivity, but we never received any advise about a maximum inactivity time, nor we received any warning about the closing of our submission. Thank you for the attention, we hope that you can help us.

bioc-issue-bot commented 3 years ago

Dear @bioinformatic-seragnoli ,

We have reopened the issue to continue the review process. Please remember to push a version bump to git.bioconductor.org to trigger a new build.

bioc-issue-bot commented 3 years ago

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

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

bioinformatic-seragnoli commented 3 years ago

Dear Marcel, in the latest version of the package we have applied many fixes you suggested. At the moment we still have to: create the unit tests, fix the "BOBaFIT" vignette with the last changes and add the verbose argument. We hope to conclude as soon as possible. Best reguards, Bioinformatics Seragnoli

bioc-issue-bot commented 3 years ago

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

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

LiNk-NY commented 3 years ago

Hi @bioinformatic-seragnoli Please make sure to respond to the review line by line. We expect maintainers to be responsive; therefore, a two week no-response merits the issue to be closed. We will make this more clear in our submission guidelines. Best, Marcel

bioc-issue-bot commented 3 years ago

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

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: "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. 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/BOBaFIT 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: fcd1559c7162b65a21c1f65b8d14082136dfe585

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: "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. 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/BOBaFIT 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: 5ca2aaa21b4b41a26a37d661875330f9a4552b29

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: "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. 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/BOBaFIT 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: 2b22530db61f7190b048dd31e5204ff29f7165bf

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: "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. 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/BOBaFIT 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: ff64d9b5380f71df628d3d2444cd8b713ad66ae3

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/BOBaFIT 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: 5b8e8d90a6c428277d535faf915cdd8eb33fb64d

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/BOBaFIT 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: 4d427e11d405e56fe48a68e39c74565856c415ca

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/BOBaFIT 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: cfbe0f9637524d0253caf6f9038b3eebbe77e69e

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/BOBaFIT 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: 24a7645702a6ed2a1d42e185e030b746149c7cd5

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

bioinformatic-seragnoli commented 3 years ago

Hi @LiNk-NY , We are about to complete the improvements to our package. As soon as possible, we will provide a detailed list of all the changes made by replying point by point to your review. Best, Bioinformatics Seragnoli

bioc-issue-bot commented 2 years ago

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

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

LiNk-NY commented 2 years ago

Hi @bioinformatic-seragnoli , Any updates on the changes? Thank you. -Marcel

bioc-issue-bot commented 2 years ago

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

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

bioinformatic-seragnoli commented 2 years ago

Hi @LiNk-NY, that's the report of all changes made based on your suggestions. Thank you, Bioinformatics Seragnoli

DESCRIPTION

  1. (optional) Ensure that the DESCRIPTION file fits within an 80-character width limit. Done
  2. Only specify version requirements for packages where you are using a feature that is not available in the older version of the package, otherwise it is not necessary. Done: all package versions are removed
  3. R depends version should be either removed or set to 4.1.0. Done: version removed

NAMESPACE

  1. Please use a more descriptive name for PlotCluster. Done: renamed as PlotChrCluster
  2. Consider using the native pipe |> to avoid the tidyr dependency. We would prefer not to use native pipe as it’s available only from R 4.1.0 and we aim to be compatible with all R versions

vignettes

  1. Please restrict the vignette to 80 character width (in vim this can be done with gqq). Done
  2. Check for typos, e.g., in the abstract:. Done
  3. Perhaps you could use that data that is already in Bioconductor such as from curatedTCGAData, GenomicDataCommons, TCGAbiolinks and others? Done: Thanks for your suggestion, we used the TCGAbiolinks package to download BRCA segments. We also integrated a vignette “Data preparation” where it explained how to process the downloaded data frame, in order to be the perfect BoBafit input .
  4. Use a more descriptive argument name (perc) for the computeNormalChromosome function. Done: we changed it in tolerance_val
  5. Please use a GRanges or GRangesList representation for computeNormalChromosomes and DRrefit to avoid manual calculations such as those for width. We decided to include the width as one of the fundamental column of the input dataset, in order to avoid the loading of another package.
  6. Separate analysis and graphing functionality. computeNormalChromosomes and DRrefit should only perform the computations and not graph. Those should be a separate functions. Done: We create a new function DRrefit_plot in order to separate the graphic part of the function. However, for computeNormalChromosome, we prefer to leave unchanged the function as the graph it’s a simple support to visualize the vector (main output of the function)

R

  1. Please add a description to the computeNormalChromosomes documentation. Done
  2. Add a verbose argument to computeNormalChromosomes and DRrefit. Done
  3. Do not use cat or print and use message. Done
  4. Resolve these errors from the example: Done
Error in as.vector(x, "character") : cannot coerce type 'closure' to vector of type 'character'
In addition: Warning messages: 
1: In max(DiffLev[, 5], na.rm = TRUE) : no non-missing arguments to max; returning -Inf
2: In matrix(c(results), nrow = 2, ncol = 26) : data length [51] is not a sub-multiple or multiple of the number of rows [2]
3: In matrix(c(results), nrow = 2, ncol = 26, dimnames = list(c("Number_clusters",  :
data length [51] is not a sub-multiple or multiple of the number of rows [2]
  1. PlotCluster seems to cycle through all the samples. Is this intended? I am not sure this can easily be interpreted / displayed. Yes, this behavior is intended, as it’s a function parallel to DRrefit that does the same analysis on the samples, but it shows in detail the computed clusters of DRrefit. If you think this is not understandable we can improve the vignettes, but it clearly says that the function “can cluster either a sample cohort or a single sample”.
  2. Please follow our package guidelines and avoid 1:n sequences. Use the more robust seq_len(n) or seq_along(x). Done
  3. Avoid the copy and append method in DRrefit, this can provide significant performance drawbacks. Done
  4. Do not save files for the user. Please remove the png & dev.off() function calls from the function and allow the user to choose their own file and graphics format. Done: Thank you for your suggestion, we added the argument plot_format into DRrefit_plotand PlotChrClusterpermits to the user to choose their own preferred format for the plots (“png”, “pdf”, “tiff” or “jpg”).

tests • Please add unit tests to the package. Done / • Remove the intermediate .md file from the vignettes folder. Done

LiNk-NY commented 2 years ago

Hi @bioinformatic-seragnoli,

  1. Consider using the native pipe |> to avoid the tidyr dependency. We would prefer not to use native pipe as it’s available only from R 4.1.0 and we aim to be compatible with all R versions

After the package is published in Bioconductor, users will not be able to use your package outside of R version >= 4.2.0. These constraints are imposed by Bioconductor versioning. I recommend that you create a legacy branch in your repository for users who have not updated their version of R and add a disclaimer stating that the package is not guaranteed to work because it was developed with a newer version of R.

  1. Separate analysis and graphing functionality. computeNormalChromosomes and DRrefit should only perform the computations and not graph. Those should be a separate functions. Done: We create a new function DRrefit_plot in order to separate the graphic part of the function. However, for computeNormalChromosome, we prefer to leave unchanged the function as the graph it’s a simple support to visualize the vector (main output of the function)

Consider creating modular functions that can accept the output of the analysis function and generate the graphs. This is the recommended way of designing pure and easily testable functions.

  1. Do not save files for the user. Please remove the png & dev.off() function calls from the function and allow the user to choose their own file and graphics format. Done: Thank you for your suggestion, we added the argument plot_format into DRrefit_plotand PlotChrClusterpermits to the user to choose their own preferred format for the plots (“png”, “pdf”, “tiff” or “jpg”).

I did not mean to provide options for the user but to allow the user to save the graphics device themselves by not having the function save the graphics. This let's the user save to any graphics format not covered by your coding, e.g., .eps, .pdf, etc.

Minor: if (x) is preferred over if (x == TRUE), when x is expected to be logical.

-MR

bioc-issue-bot commented 2 years ago

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

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

bioc-issue-bot commented 2 years ago

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

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

bioc-issue-bot commented 2 years ago

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