Bioconductor / Contributions

Contribute Packages to Bioconductor
131 stars 33 forks source link

KnowSeq R package #1121

Closed CasedUgr closed 5 years ago

CasedUgr commented 5 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 5 years ago

Hi @CasedUgr

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: KnowSeq
Type: Package
Title: A R package to extract knowledge by using RNA-seq raw files. 
Version: 0.9.99
Author: Daniel Castillo, Juan Manuel Galvez, Luis Javier Herrera and Ignacio Rojas.
Maintainer: Daniel Castillo Secilla <cased@ugr.es>
Description: KnowSeq proposes a whole pipeline that comprises the most relevant steps in the RNA-seq gene expression analysis. In this sense, this package allows align raw data from the original fastq files by using the most renowned aligners such as tophat2, hisat2, salmon and kallisto. This is the most important implementation of this package as with only a text file with the information of the samples to align, the tool will perform the download and alignment of all of them automatically with the selected aligner. Furthermore, the package includes functions to calculate the gene expression values, to remove batch effect, to calculate the Differentially Expressed Genes (DEGs), to plot different graphs, and to perform the DEGs enrichment with the GO information, pathways visualization and related diseases information retrieval.
VignetteBuilder: knitr
License: GPL (>=2)
Depends: R (>= 3.5.0), quantreg, mclust, Biobase, multtest, topGO (>= 2.34.0), pathview (>= 1.22.3)
Encoding: UTF-8
LazyData: true
RoxygenNote: 6.1.1
biocViews: GeneExpressionWorkflow
Imports: stringr, factoextra, ggplot2, reshape2, gplots, caret, RCurl, XML, class, praznik, R.utils, e1071, randomForest, httr, jsonlite, sva (>= 3.30.1), cqn (>= 1.28.1), edgeR (>= 3.24.3), biomaRt (>= 2.38.0), limma (>= 3.38.3), arrayQualityMetrics (>= 3.38.0), tximport (>= 1.10.1), tximportData (>= 1.10.0), rhdf5 (>= 2.26.2)
mtmorgan commented 5 years ago

Please update your vignette to include fully evaluated code chunks

```{r}
...
```

rather than

```r
```

The header also requires revision, to

KnowSeq/vignettes master$ less KnowSeq.Rmd
~/a/new_packages/KnowSeq/vignettes master$ git diff KnowSeq.Rmd
diff --git a/vignettes/KnowSeq.Rmd b/vignettes/KnowSeq.Rmd
index 5eb1249..5112a3f 100644
--- a/vignettes/KnowSeq.Rmd
+++ b/vignettes/KnowSeq.Rmd
@@ -23,8 +23,10 @@ header-includes:
 link-citations: yes
 BiocStyle::html_vignette:
   md_extensions: -autolink_bare_uris
-vignette: "%\\VignetteIndexEntry{The KnowSeq users guide} %\\VignetteEngine{knitr::rmarkdown}
-  %\\VignetteEncoding{UTF-8} \n"
+vignette: |
+  %\VignetteIndexEntry{The KnowSeq users guide}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
 ---

Please also use the modern SummarizedExperiment rather than Biobase / ExpressionSet.

Please post a comment here when you have made these changes, and I will add your package to the review queue.

CasedUgr commented 5 years ago

Hello:

First of all, thanks for the quickly response. I have some trouble with the two requirements due to the nature of our package.

1.- Please update your vignette to include fully evaluated code chunks: Our package needs in the first step of the pipeline the user interaction. Due to this consideration, the full evaluated code chunk rais an error just at the start of the documentation that doesn't allows to continue the evaluation correctly. We can't solve it because the code needs a folders hierarchy and a set of files that are created in real time, or by the user. If you could give us some advice to solve it We would appreciate it.

2.- Please also use the modern SummarizedExperiment [1] rather than Biobase / ExpressionSet: We use internally the Bioconductor package "ArrayQualityMetrics" to perform the Quality Analysis, and this library uses ExpressionSet. It is the only appearance of ExpressionSet in our package due to the Quality analysis step require it because "ArrayQualityMetrics" doesn't allows SummarizedExperiment. The only solution if the ExpressionSet has to be removed is make again the whole quality analysis step of our package.

Thank you in advance and I'm looking forward to hear from you.

El 2019-05-15 23:27, Martin Morgan escribió:

Please update your vignette to include fully evaluated code chunks

...

rather than

Please also use the modern SummarizedExperiment [1] rather than Biobase / ExpressionSet.

Please post a comment here when you have made these changes, and I will add your package to the review queue.

-- You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub [2], or mute the thread [3].

Links:

[1] https://bioconductor.org/packages/SummarizedExperiment [2]

https://github.com/Bioconductor/Contributions/issues/1121?email_source=notifications&amp;email_token=AI3MRDO62CJ37CQQ5CIENATPVR52RA5CNFSM4HND3P42YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODVP73KA#issuecomment-492830120 [3]

https://github.com/notifications/unsubscribe-auth/AI3MRDJG4EH2JGUGNGXW4GLPVR52RANCNFSM4HND3P4Q

-- Daniel Castillo Secilla Deparment of Architecture and Computer Technology (ATC) ETS Ing. Informática y Telecomunicación (ETSIIT) Centro de Investigación en Tecnologías de la Información y la Comunicación (CITIC) Despacho D1-7 University of Granada, Spain

mtmorgan commented 5 years ago

One can use 'mock' data from an existing experiment data package or a SMALL dataset included in the inst/extdata folder and accessible with system.file(package="<your package>", "extdata"). Outputs can be generated in dir <- tempfile(); dir.create(dir).

Since your package uses arrayQualityMetrics, you may ignore the second requirement.

CasedUgr commented 5 years ago

Hello:

The fully evaluated code chunk has been added to the documentation. There are only three pieces of code at the start of the documentation without the evaluation because the user interaction in command line is required, and it is imposible to achieved it in the markdown compiler. Concretely, the function rawAlignment but, the rest of the package can be evaluated in real time in the documentation. Furthermore, to carry out this goal, a new folder with 10 limited count files has been added to the extdata folder.

We hope that all would be fine now for the evaluation of our package but if you need more requirement just tell us.

Thank you in advance and I'm looking forward to hear from you.

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

bioc-issue-bot commented 5 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, 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 5 years ago

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

5b8a736 KnowSeq V0.99.0ç

bioc-issue-bot commented 5 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, 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 5 years ago

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

b9c5911 KnowSeqV0.99.1

bioc-issue-bot commented 5 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 5 years ago

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

d27fbd1 KnowSeqV0.99.2

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

Kayla-Morrell commented 5 years ago

Hello @CasedUgr - Thank you for your submission to Bioconductor. I see that this is considered a workflow package based on the biocViews tag used in the DESCRIPTION file but then you also introduce some functionality within the package (much like a software package). My suggestion would be to put all the functionality into a separate software package and then have the workflow package be just an in-depth vignette walking through the functions. The software package can be added to this thread using 'Additional package:' with the github repo url. Please let me know if you have any questions.

Best, Kayla

CasedUgr commented 5 years ago

Dear Kayla. First of all, thanks for your message. We would like to note that we do not understand well the reasons to create two different packages (Software & Workflow). We see the package as you pointed out as a set of powerful functions with a workflow that can be followed from a source data to relevant knowledge that can be extracted from it.

So please if possible specify a little bit more why should be provide two different packages and how to organize them so that we can succesfully understand and apply the changes you require.

bioc-issue-bot commented 5 years ago

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

45f62e2 KnowSeq V0.99.4

bioc-issue-bot commented 5 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 5 years ago

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

3090c45 KnowSeq V0.99.5

bioc-issue-bot commented 5 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 5 years ago

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

4c08920 KnowSeq V0.99.6

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

CasedUgr commented 5 years ago

Hello, We made tonight a new build changing the biocViews tag to tags related with a Software package. We thought that KnowSeq has better relation with this category. However, if you note that its also required another package with the workflow, we would do it.

Thank you in advance.

Best,

Daniel

Kayla-Morrell commented 5 years ago

Hello @CasedUgr - Thank you for making the changes. Since this package is now a software package then the additional workflow package is not needed. The idea of having a workflow package is to accompany a software package by demonstrating a pipeline through a more in-depth vignette, it's normally lighter weight and contains little to no actual R code. What you currently have is sufficient and I will continue with my review.

Best, Kayla

Kayla-Morrell commented 5 years ago

Hello @CasedUgr,

Thank you for your submission to Bioconductor. Please see the initial review of 'KnowSeq' below. Comment back here with updates that have been made and when the package is ready for re-review.

DESCRIPTION

NAMESPACE

NEWS

data

Vignettes

man pages

Unit tests

R code

Best, Kayla

bioc-issue-bot commented 5 years ago

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

8713792 KnowSeqV0.99.7

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

CasedUgr commented 5 years ago

Dear @Kayla-Morrell :

We have upload the new built with the revision requirements. In this sense, I am going to response each point in bold and italic. We hope that the package accomplish now the bioconductor guidelines, but if we have to perform more changes just tell us.

Thanks in advance for your revision.

DESCRIPTION

Done.

Unit tests

  • [x] SUGGESTION: Consider adding unit tests. We strongly encourage them. The unit tests have not been included in this release, but we are planning to add them in next releases when we planned them.

    R code

  • [x] REQUIRED: Use various apply functions, such as vapply() instead of for loops were applicable. Done. Around 8 loops for was changed by vapply.
  • [x] REQUIRED: Use system2() instead of system(). Done.
  • [x] REQUIRED: Avoid sapply(), use vapply() instead. Found in files:

    • svm_CV.R, line 72
    • svm_CV.R, line 73
    • svm_CV.R, line 97
    • svm_CV.R, line 98

Done.

  • [x] SUGGESTION: Consider shorter lines, 992 lines (18%) are > 80 characters long. This change has not been applied.

  • [x] SUGGESTION: Consider multiples of 4 spaces for line indents, 1087 lines (20%) are not. This change has not been applied.

Best,

Daniel

Kayla-Morrell commented 5 years ago

Hello @CasedUgr - Thank you for making the necessary changes. I just have a couple more points and then your package should be ready to be accepted. Please comment back here when you are ready for me to look at the changes.

vignette

Best, Kayla

bioc-issue-bot commented 5 years ago

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

46811c3 KnowSeq V0.99.8

bioc-issue-bot commented 5 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: "TIMEOUT, 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 5 years ago

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

f918932 KnowSeq V0.99.9

bioc-issue-bot commented 5 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 5 years ago

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

78c55f3 KnowSeq V0.99.10

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

bioc-issue-bot commented 5 years ago

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

e442ff1 KnowSeq V0.99.11

bioc-issue-bot commented 5 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 5 years ago

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

ab51ba1 KnowSeq V0.99.12

bioc-issue-bot commented 5 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 5 years ago

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

492d1c4 KnowSeq V0.99.13

bioc-issue-bot commented 5 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: "TIMEOUT, 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 5 years ago

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

e3b7146 KnowSeq V0.99.20

bioc-issue-bot commented 5 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 5 years ago

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

d4f36de KnowSeqw V0.99.21

bioc-issue-bot commented 5 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 5 years ago

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

f731f9b KnowSeqw V0.99.22

bioc-issue-bot commented 5 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 5 years ago

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

ff3af68 KnowSeqw V0.99.25

bioc-issue-bot commented 5 years ago

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

095d984 KnowSeq V0.99.26

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