Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

GARS #648

Closed BioinfoMonzino closed 6 years ago

BioinfoMonzino commented 6 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 6 years ago

Hi @BioinfoMonzino

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: GARS
Type: Package
Date: 2017-09-25
Title: GARS: a clustering-based Genetic Algorithm for the identification
 of Robust Subsets of variables in high-dimensional and challenging
 datasets
Version: 0.99.0
Author: Mattia Chiesa <mattia.chiesa@hotmail.it>, 
    Luca Piacentini <luca.piacentini@cardiologicomonzino.it>
Maintainer: Mattia Chiesa <mattia.chiesa@hotmail.it>
Description: More about what it does (maybe more than one line)
    Use four spaces when indenting paragraphs within the Description.
License: GPL (>= 2)
Encoding: UTF-8
LazyData: true
VignetteBuilder: knitr
RoxygenNote: 6.0.1
biocViews: Classification, FeatureExtraction
Imports: DaMiRseq, MLSeq, stats, methods
Suggests: BiocStyle, knitr, testthat
Depends: R (>= 3.4), ggplot2, cluster
bioc-issue-bot commented 6 years ago

A reviewer has been assigned to your package Learn What to Expect during the review process.

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.

mtmorgan commented 6 years ago

Looks like the Description: field needs updating.

bioc-issue-bot commented 6 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, 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.

bioc-issue-bot commented 6 years ago

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

2a7f362 update DESCRIPTION file

BioinfoMonzino commented 6 years ago

We have modified and updated the Description file as suggested. We have also bumped the version from 0.99.0 to 0.99.1.

bioc-issue-bot commented 6 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.

BioinfoMonzino commented 6 years ago

Dear reviewers, GARS is in ERROR status in OS X system. This is due to the dependency "DaMiRseq" that depends on FSelector and, in turn, on RWeka/RWekajars, which is in ERROR in the OS X system (https://cran.r-project.org/web/checks/check_results_RWeka.html). By the way, I have the same problem with "DaMiRseq" package, which is OK in the current version (all systems), OK in Windows and Unix (devel version) and ERROR in OS X (devel version). How could I handle this issue?

lshep commented 6 years ago

For now you can ignore the MAC ERROR, we will look into it on our end. It may be that the binaries are not yet available for MAC which is still an issue with a number of CRAN packages, once those binaries are available this will clear up. I will look if it there is something additional to this.

In the meantime, I will review your package in the next day or two and have an official review for you.

lshep commented 6 years ago

Thank you for your submission to Biocoductor. Please see the comments below:

Build Report

Organizational

man For your data object can you please explain in more detail how the objects were created.

vignette

R CODE In general the code looks good and well formatted.

Please address the above issues, when ready ensure that a new build report is created with a version bump and please comment back here with what has been updated or comments to address any concerns.

Cheers, Lori

bioc-issue-bot commented 6 years ago

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

50f3513 GARS version 0.99.2

BioinfoMonzino commented 6 years ago

Dear Lori, thanks for your suggestions, which have been really useful! We addressed most of your issues:

  1. We created a S4 object to store the outputs of GARS: we named this S4 object “GarsSelectedFeatures”; then, we implemented four generic functions (MatrixFeatures, AllPop, LastPop, FitScore) to extract the information from the “GarsSelectedFeatures” class object. We also tried to document class and methods, following the roxygen2 specifications. However, we got these warnings, which we are not able to address:
<U+2714>  checking Rd cross-references
W  checking for missing documentation entries
   Undocumented S4 classes:
     'GarsSelectedFeatures'
   Undocumented S4 methods:
     generic 'AllPop' and siglist 'GarsSelectedFeatures'
     generic 'FitScore' and siglist 'GarsSelectedFeatures'
     generic 'LastPop' and siglist 'GarsSelectedFeatures'
     generic 'MatrixFeatures' and siglist 'GarsSelectedFeatures'
   All user-level objects in a package (including S4 classes and methods)
   should have documentation entries.
   See chapter 'Writing R documentation files' in the 'Writing R
   Extensions' manual.

<U+2714>  checking for code/documentation mismatches
W  checking Rd \usage sections
   Objects in \usage without \alias in documentation object 'AllPop methods':
     '\S4method{AllPop}{GarsSelectedFeatures}'
   Objects in \usage without \alias in documentation object 'FitScore methods':
     '\S4method{FitScore}{GarsSelectedFeatures}'
   Objects in \usage without \alias in documentation object 'LastPop methods':
     '\S4method{LastPop}{GarsSelectedFeatures}'
   Objects in \usage without \alias in documentation object 'MatrixFeatures methods':
     '\S4method{MatrixFeatures}{GarsSelectedFeatures}'
   Functions with \usage entries need to have the appropriate \alias
   entries, and all their arguments documented.
   The \usage entries must correspond to syntactically valid R code.
   See chapter 'Writing R documentation files' in the 'Writing R
   Extensions' manual.

Please, do you have any suggestions?

  1. We added .gitignore file with ^.*.Rproj$ and ^.Rproj.user$
  2. We renamed all the functions, replacing '.' with '_';
  3. In the vignette, we used the cervical names to create the ‘class_vector’;
  4. Concerning the functions embedded in GARS_GA, the user can exploit them to generate a custom GA: e.g. a user could decide to skip the Elitism step; we added a brief explanatory section in the vignette;
  5. Now GARS_GA, GARS_FitFun and GARS_create_rnd_population are able to take a “SummaizedExperiment” object;
  6. Concerning the global variables, actually we do not use global variables inside functions; so we did not address this note.
bioc-issue-bot commented 6 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, 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.

lshep commented 6 years ago

Thank you for your updates a few minor comments below:

Build Report

man

Cheers,

bioc-issue-bot commented 6 years ago

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

7aa8317 update version 0.99.3

BioinfoMonzino commented 6 years ago

Dear Lori, thanks for your suggestions! We addressed all your issues except the last one. In particular:

  1. we added *.Rproj and GARS.proj to the .gitignore file;
  2. we handled globar variables and functions; now, there isn't any NOTES;
  3. we added Clustering to biocViews; Regression is not applicable to GARS.
  4. we modified the documentation codes of the GarsSelectedFeaturesclass and its methods; the WARNING massages disappeared. Concerning the last point, we do not understand exactly what you mean for " GARS package page". Thanks again!
bioc-issue-bot commented 6 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.

lshep commented 6 years ago

The last point about a GARS package page in documentation - Would be to create a man packaga for GARS or having an \alias{GARS} so that a users could type ?GARS and be directed to a man page describing the package and the main function or directly to the main function of the package.

bioc-issue-bot commented 6 years ago

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

e4dbf35 updates version 0.99.4

BioinfoMonzino commented 6 years ago

Dear @lshep , we added the man package for GARS. You can check it, typing ?GARS Thanks.

bioc-issue-bot commented 6 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.

bioc-issue-bot commented 6 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.

lshep commented 6 years ago

One last minor comment: In the vignette: when you run the GARS_GA function - you show two plots in the vignette but only one is produced when running the function in linux - could it be worth saying how you would generate Figure 1: Fitness Evolution plot - Or changing the plotting output to depict both par(mfrow=c(2,1)) ?

bioc-issue-bot commented 6 years ago

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

77215b8 updates 0.99.5

BioinfoMonzino commented 6 years ago

Dear @lshep, following your suggestion we tried par(mfrow=c(2,1)) inside GARS_GA. However, it does not seem to have effect on plots generated by ggplot2. So, we decided to modify the vignette: in the first chunk, we launched GARS_GA with plot = “no”. Then, we added a paragraph and a new chunk, where we explained how to use the functions GARS_PlotFitnessEvolution() and GARS_PlotFeaturesUsage(). Could it be ok, now? Thanks again!

bioc-issue-bot commented 6 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.

bioc-issue-bot commented 6 years ago

Your package has been accepted. It will be added to the Bioconductor Git repository and nightly builds. Additional information will be posed to this issue in the next several days.

Thank you for contributing to Bioconductor!

mtmorgan commented 6 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/BioinfoMonzino.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(\"GARS\"). The package 'landing page' will be created at

https://bioconductor.org/packages/GARS

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.