Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

(inactive) MulEA #497

Closed koralgooll closed 6 years ago

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

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:

#: #: https://www.bioconductor.org/packages/devel/BiocViews.html#___Software
Package: MulEA
Type: Package
Title: MulEA - A Tool for Multi Enrichment Analysis
Version: 0.99.0
Date: 2016-04-08
Authors@R: c(
    person("Wiktor", "Jurkowski", email = "Wiktor.Jurkowski@earlham.ac.uk", role = "aut"),
    person("Eszter", "Ari", email = "arieszter@gmail.com", role = c("aut", "cph")),
    person("Cezary", "Turek", email = "Cezary.Turek@gmail.com", role =  c("aut", "cre")),
    person("Peter", "Forgacs", email = "Peter.Forgacs3@gmail.com", role =  "ctb"))
Description:
    Functional interpretation of the biological data typically involves identifying key genes, molecules, reactions or pathways by finding non-random changes between two or more conditions or phenotypes. Performing enrichment analysis on set of molecules selected from  differential omics analysis is a method of choice. Among many packages that can be applied for this task, only few could be applied either to multiple species, ontology types or providing an access to multiple statistics.
    MulEA is addressing this gap in addition providing improved way to calculate correction for multiple testing that assume partial dependence between ontology terms and in result limits number of correct associations falsely scored as insignificant. Besides the commonly applied tests, MulEA provides a unique permutation based, empirical false discovery rate correction of the p-values to substitute the too conservative Bonferroni and Benjamini-Hochberg procedures.
    MulEA allows enrichment analysis using most popular gene and pathway ontologies (GO, KEGG, Reactome). In addition, one can test enrichment in genomic locations and in gene expression, protein domain, miRNA and transcription factors data bases, all created from publicly available resources and presented in standardized manner. Beyond genes or proteins, MulEA even allows working with basically any kind of data types, i.e. small molecules, chromosome region, enhancers, molecular interactions or any other information defined by the user.
    Mulea currently supports 25 organisms from bacteria to human. Because, in addition to knowledge-bases provided alongside the package, the user may provide its own ontology files, MulEA can work with any biological species.
    To analyse the data MulEA provide multiple types of statistics in one tool, which allows the user to calculate over-representations using the hypergeometric test, and enrichment analyses of ranked input by the Kolmogorov-Smirnov test.
    To conclude, MulEA is a comprehensive enrichment software that allows expansive analyses using diverse ontologies, statistical models and p-value correction procedures that can extend our understanding of the results of various high-throughput analyses and therefore expand our knowledge.
License: GPL-2
LazyData: TRUE
Imports:
    DBI (>= 0.7.0),
    RSQLite (>= 2.0.0),
    plyr (>= 1.8.4),
    methods (>= 3.3.2),
    fgsea (>= 1.0.2)
Depends:
    R (>= 3.4.0)
Suggests:
    knitr,
    rmarkdown,
    testthat
VignetteBuilder: knitr
LinkingTo: 
Collate:
    'Mulea.R'
    'GenericFunctions.R'
    'Utils.R'
    'LocalDb.R'
    'Methods.R'
    'MuleaData.R'
    'HypergeometricTest.R'
    'ChiSquaredTest.R'
    'KolmogorovSmirnovTest.R'
    'SubramanianTest.R'
    'PathNetTest.R'
    'SetBasedTest.R'
    'RankedBasedTest.R'
URL: http://yihui.name/knitr/
BugReports: https://github.com/yihui/knitr/issues
biocViews:
    BiomedicalInformatics,
    GeneSetEnrichment
RoxygenNote: 6.0.1
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.

On one or more platforms, the build results were: "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 following build report for more details:

http://bioconductor.org/spb_reports/MulEA_buildreport_20170926093909.html

lawremi commented 7 years ago

Looks like the URL and BugReports is for another package. Need to be more careful with the copy and pasting ;) This should integrate with Bioconductor somehow, perhaps through GSEAbase data structures? I don't think the vignette needs to cite the Wikipedia definition of data analysis.

koralgooll commented 7 years ago

I have changed the values in DESCRIPTION. Yes, some times "copy-paste" method fails. But where you are a very beginner in R's world, it helps a lot. :) I do not really understand that sentence "This should integrate with Bioconductor somehow, perhaps through GSEAbase data structures?", can you explain it a little more? I have decided to cite the Wikipedia definitions, because when I were a beginner, I had to spend sometimes more time to digging if the author was writing about that method or maybe about a different one. The problem of naming. Should I remove it, or can I leave it?

bioc-issue-bot commented 7 years ago

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

0c11281 Build MulEA 0.99.1

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/MulEA_buildreport_20170926152641.html

bioc-issue-bot commented 7 years ago

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

93b5daf Clear inst/doc/ directory 57aa7cc Build MulEA 0.99.2

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/MulEA_buildreport_20170926153711.html

wjurkowski commented 7 years ago

@lawremi Excellent suggestion. We will add use of GSEABase to the list of our priorities

koralgooll commented 7 years ago

@lawremi, @wjurkowski is one of the authors of MulEA. :)

koralgooll commented 7 years ago

Hi @lawremi what is the process now? Is MulEA accepted?

lawremi commented 7 years ago

No, @hpages needs to formally review, and you'll likely be expected to actually integrate with GSEABase, or some other Bioc integration point.

hpages commented 6 years ago

Hi @koralgooll @wjurkowski

Thanks for the submission. Here is some quick initial feedback below. Please address at your earliest convenience. Thanks,

H.

bioc-issue-bot commented 6 years ago

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

71d0620 Bunch of necessary corrections. 6ba5bb9 Build MulEA 0.99.3

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 following build report for more details:

http://bioconductor.org/spb_reports/MulEA_buildreport_20171024173918.html

koralgooll commented 6 years ago

Hi @hpages

Thanks for your comments explaining how can we improve our package. I want to say that we apply all suggestions, requirements to our package. :)

hpages commented 6 years ago

Hi @koralgooll @wjurkowski,

Thanks for the improvements to the package. Many problems remain, see below for the details (some are problems reported previously, others are new problems). Overall the package feels like a work-in-progress and lacks maturity. At this point, it's not realistic to aim for inclusion to the BioC 3.6 release (scheduled for Oct 31), only for the BioC 3.7 release. Thanks for your understanding.

Regards, H.

  1. Any progress on GSEABase use? Don't hesitate to ask on the bioc-devel list if you need help or clarification about this.

  2. License not properly specified (as reported by R CMD check). See my previous feedback for how to properly point to the LICENSE file.

  3. These R CMD check NOTEs should not be ignored:

    * checking R code for possible problems ... NOTE
    calculateChiSquaredTest: Error while checking: object 'chisq.test' not
    found
    calculateFisherTest: Error while checking: object 'fisher.test' not
    found
    initialize,pathNetTest : <anonymous>: no visible global function
    definition for ‘get.adjacency’
    initialize,pathNetTest : <anonymous>: no visible global function
    definition for ‘PathNet’
  4. The vignette still has a lot of problems. These problems show up in the HTML version of the vignette. Please take a look at it (do R CMD build MulEA, R CMD INSTALL MulEA_0.99.3.tar.gz, then start R and do browseVignettes(package="MulEA")) and fix the problems you see. Note that the commands used to generate figures (e.g. calls to knitr::kable) are internal business of the vignette itself and should not be shown to the user. Show to the user the commands that s/he will use in a typical MulEA workflow.

  5. What's the purpose of doing muleaPkgDir <- find.package("MulEA") in your examples if you're not going to use muleaPkgDir? Please clean up the examples in your man pages.

  6. Your function names are inconsistent and confusing e.g. it should be obvious for the end user that readGmtFileAsDF and saveModelFromDataFrameToGmtFile are opposite functions but unfortunately it's not.

  7. It's considered good practice to document a pair of I/O functions like readGmtFileAsDF and saveModelFromDataFrameToGmtFile in the same man page.

  8. Generally speaking your examples need to be straight to the point and not distract the user with things that do not illustrate the functionality being documented in the man page. For example in the man page for readGmtFileAsDF and saveModelFromDataFrameToGmtFile, there is no need to show how to make modelDfFromFile go in and out the database.

  9. startLocalDatabase and stopLocalDatabase are misnomers. "Starting" a db suggests that a db server (e.g. MySQL) is started. These functions don't do that. They create a new SQLite db or remove it, which is quite different.

  10. The design of the whole db manipulation tools is awkward. It doesn't give the impression that it has gone thru a lot of testing. Has this been used in a real working environment?

bioc-issue-bot commented 6 years ago

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

5636608 Build MulEA 0.99.4

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

http://bioconductor.org/spb_reports/MulEA_buildreport_20171026045542.html

wjurkowski commented 6 years ago

Hi @hpages! Thank you for thorough review! It would be great to have the package included in BioC 3.6. @kolargoll made all the changes required to address points on your list except point one. Because GBASe is gene set oriented and our package isn't it is of limited value for us hence not a biggest priority. Of course we will add support to use it in future releases to establish as many connection as possible but we hope it is not going to be a road blocker at this stage.

koralgooll commented 6 years ago

Hi @hpages can you help me to solve problem with > MulEA::saveDataFrameAsGmtFile(modelDF = modelDfFromFile, gmtFilePath = "~/fromDb.gmt")? This is what cause problem on Windows build.

I am not able to investigate it. I haven't changed that line in examples. it is there from very beginning. In previous builds the error didn't occurred.

bioc-issue-bot commented 6 years ago

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

720b35e Build MulEA 0.99.5

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 following build report for more details:

http://bioconductor.org/spb_reports/MulEA_buildreport_20171026053157.html

koralgooll commented 6 years ago

Hi @hpages , I have solved all problems, including build on Windows. Can you review please? :) 2-8) Solved in code. 9-10) DB's functionality was revoke for that release.

hpages commented 6 years ago

Hi @koralgooll, @wjurkowski,

Thanks for making these changes.

As @lawremi commented, lack of integration with the Bioconductor ecosystem is a concern right now. I'm not a GSEABase expert so can't provide insight on whether re-using some of the GSEABase infrastructure would be appropriate for MulEA. This is why I strongly suggest that you engage in some discussion on the bioc-devel list about this. Martin Morgan (GSEABase's first author) and other GSEABase experts will provide valuable feedback.

Many problems remain. Reporting only a few below (too many problems to list them all).

Regards, H.

  1. The reason R CMD build doesn't fail when creating the vignette is because chunk global option error is set to TRUE. You must set it to FALSE. Also there is no reason to ignore warnings or messages. So:

    knitr::opts_chunk$set(echo=TRUE, warning=TRUE, message=TRUE, error=FALSE)

    See https://yihui.name/knitr/options/ for more information.

  2. Duplicated line in examples for readGmtFileAsDataFrame.

  3. The SetBasedTest and RankedBasedTest classes need to be exported and have a "show" method.

  4. Showing the output of str() on a particular instance doesn't really explain what the structure of the "model data frame" is expected to be. Please provide proper explanation of what the expectations are. Also your code needs to check that these expectations are satisfied and fail graciously with an informative error message if they are not.

  5. It is more than reasonable to assume that the reader of your vignette knows what "Data analysis" means. As suggested by @lawremi please remove.

  6. The vignette and man pages have many typos. Please use a spell-checker to find and fix them.

wjurkowski commented 6 years ago

Hi @hpages, Thank's for all your help. I'm going to take care of the vignette and hope to have it improved soon. With regards to integration with other packages, we are all BioC users and are aware of its content pretty well, therefore also in this case are reusing existing code (e.g. fgsea package) and are happy to continue doing so in the future

hpages commented 6 years ago

Hi @wjurkowski, @koralgooll, I was wondering if you made any progress on this? Thanks. H.

hpages commented 6 years ago

Hi @koralgooll, @wjurkowski,

Are you planning to follow up with this submission? If I don't hear from you and don't see any activity in this issue before the end of March, I'll close the issue.

Best, H.

koralgooll commented 6 years ago

@hpages yes, we will try again.

bioc-issue-bot commented 6 years ago

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

4348394 Build MulEA 0.99.6

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: "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

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

57519e2 Build MulEA 0.99.7

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: "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

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

3b1fa25 Fixes for BioConductor checks. d3d23c8 Build MulEA 0.99.8

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". 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:

99ba64b R version bump to 3.5.0 9d431a6 Build MulEA 0.99.9

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

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

b88e1ab Build MulEA 0.99.10

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.

koralgooll commented 6 years ago

Hi @hpages can you look at our package? @wjurkowski I think we are ready to go with package submission. Do you want to add some extra comment?

hpages commented 6 years ago

Hi,

The main concern is still the lack of integration with the Bioconductor ecosystem. This has been brought to your attention several times since you started this submission 6 months ago and has been ignored so far. Also various other issues I reported earlier still remain.

I'm sorry that I have to decline this submission. You're welcome to try to submit MulEA again in the future once all the current concerns have been properly addressed.

Best regards, H.