Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

MIRit #3249

Closed jacopo-ronchi closed 8 months ago

jacopo-ronchi commented 11 months 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 11 months ago

Hi @jacopo-ronchi

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: MIRit
Title: Integrate microRNA and gene expression to decipher pathway complexity
Version: 0.99.0
Date: 2023-11-23
Authors@R: c(
    person("Jacopo", "Ronchi", email = "jacopo.ronchi@unimib.it",
 role = c("aut", "cre"), comment = c(ORCID = "0000-0001-5520-4631")),
    person("Maria", "Foti", email = "maria.foti@unimib.it",
 role = c("fnd"), comment = c(ORCID = "0000-0002-4481-1900")))
Description: MIRit is an R package that provides several methods for
    investigating the relationships between miRNAs and genes in different
    biological conditions. In particular, MIRit allows to explore the functions
    of dysregulated miRNAs, and makes it possible to identify miRNA-gene
    regulatory axes that control biological pathways, thus enabling the users
    to unveil the complexity of miRNA biology. MIRit is an all-in-one framework
    that aims to help researchers in all the central aspects of an integrative
    miRNA-mRNA analyses, from differential expression analysis to network
    characterization.
License: GPL (>= 3)
URL: https://github.com/jacopo-ronchi/MIRit
BugReports: https://support.bioconductor.org/tag/MIRit
biocViews: Software, GeneRegulation, NetworkEnrichment, NetworkInference, Epigenetics, FunctionalGenomics, SystemsBiology, Network, Pathways, GeneExpression, DifferentialExpression
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
Imports: 
    AnnotationDbi,
    BiocFileCache,
    BiocParallel,
    DESeq2,
    edgeR,
    fgsea,
    genekitr,
    geneset,
    ggplot2,
    ggpubr,
    graph,
    graphics,
    graphite,
    grDevices,
    httr,
    limma,
    methods,
    MultiAssayExperiment,
    Rcpp,
    readxl,
    Rgraphviz (>= 2.44.0),
    rlang,
    stats,
    utils
Collate: 
    'AllGenerics.R'
    'AllClasses.R'
    'MIRit-package.R'
    'RcppExports.R'
    'association.R'
    'batch-correction.R'
    'data.R'
    'differential-expression.R'
    'enrichment.R'
    'integration.R'
    'show-methods.R'
    'targets.R'
    'topological-integration.R'
    'utils.R'
    'visualization.R'
Suggests: 
    BiocStyle,
    biomaRt,
    BSgenome.Hsapiens.UCSC.hg38,
    GenomicRanges,
    ggrepel,
    ggridges,
    Gviz,
    gwasrapidd,
    knitr,
    MonoPoly,
    org.Hs.eg.db,
    rmarkdown,
    testthat (>= 3.0.0)
Depends: 
    R (>= 4.2.0)
LazyData: false
VignetteBuilder: knitr
Config/testthat/edition: 3
LinkingTo: 
    Rcpp
bioc-issue-bot commented 11 months ago

Your package has been added to git.bioconductor.org to continue the pre-review process. A build report will be posted shortly. Please fix any ERROR and WARNING in the build report before a reviewer is assigned or provide a justification on why you feel the ERROR or WARNING should be granted an exception.

IMPORTANT: Please read this documentation for setting up remotes to push to git.bioconductor.org. All changes should be pushed to git.bioconductor.org moving forward. It is required to push a version bump to git.bioconductor.org to trigger a new build report.

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 11 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Single Package Builder.

On one or more platforms, the build results were: "TIMEOUT, 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.

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.2 LTS): MIRit_0.99.0.tar.gz macOS 12.7.1 Monterey: MIRit_0.99.0.tar.gz

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

bioc-issue-bot commented 11 months ago

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

bioc-issue-bot commented 11 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Single Package Builder.

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.

The following are build products from R CMD build on the Single Package Builder: macOS 12.7.1 Monterey: MIRit_0.99.1.tar.gz Linux (Ubuntu 22.04.2 LTS): MIRit_0.99.1.tar.gz

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

bioc-issue-bot commented 10 months ago

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

bioc-issue-bot commented 10 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Single Package Builder.

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.

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.2 LTS): MIRit_0.99.2.tar.gz macOS 12.7.1 Monterey: MIRit_0.99.2.tar.gz

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

bioc-issue-bot commented 10 months ago

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

bioc-issue-bot commented 10 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Single Package Builder.

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.

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.2 LTS): MIRit_0.99.3.tar.gz macOS 12.7.1 Monterey: MIRit_0.99.3.tar.gz

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

lshep commented 10 months ago

Please fix all ERROR, Warning or Notes in the above build report before a reviewer is assigned for an in depth review. thank you

jacopo-ronchi commented 10 months ago

Please fix all ERROR, Warning or Notes in the above build report before a reviewer is assigned for an in depth review. thank you

Yes sure, i am working on it. The error was caused because of missing IS_BIOC_BUILD_MACHINE variable in the SPB Renviron file. However, i described the issue on the Bioc-devel mailing list and, thanks to Lori, the environment variable has been added. Thus, the error won't occur during the next build.

Regarding the warning, i have cached different things and i am working to reduce R CMD Check on MacOS, which takes longer than 10 minutes. If you have any suggestion i would be glad to make the required changes.

Best regards, Jacopo

lshep commented 10 months ago

ah sorry @jacopo-ronchi I didn't connect the two with the request on the mailing list. Cheers!

bioc-issue-bot commented 10 months ago

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

bioc-issue-bot commented 10 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Single Package Builder.

Congratulations! The package built without errors or warnings on all platforms.

Please see the build report for more details.

The following are build products from R CMD build on the Single Package Builder: macOS 12.7.1 Monterey: MIRit_0.99.4.tar.gz Linux (Ubuntu 22.04.2 LTS): MIRit_0.99.4.tar.gz

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

bioc-issue-bot commented 10 months ago

A reviewer has been assigned to your package for an indepth review. Please respond accordingly to any further comments from the reviewer.

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Single Package Builder.

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.

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.3 LTS): MIRit_0.99.5.tar.gz macOS 12.7.1 Monterey: MIRit_0.99.5.tar.gz

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

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Single Package Builder.

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.

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.3 LTS): MIRit_0.99.6.tar.gz macOS 12.7.1 Monterey: MIRit_0.99.6.tar.gz

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

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Single Package Builder.

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.

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.3 LTS): MIRit_0.99.7.tar.gz macOS 12.7.1 Monterey: MIRit_0.99.7.tar.gz

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

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Single Package Builder.

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.

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.3 LTS): MIRit_0.99.8.tar.gz macOS 12.7.1 Monterey: MIRit_0.99.8.tar.gz

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

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Single Package Builder.

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.

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.3 LTS): MIRit_0.99.9.tar.gz macOS 12.7.1 Monterey: MIRit_0.99.9.tar.gz

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

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Single Package Builder.

Congratulations! The package built without errors or warnings on all platforms.

Please see the build report for more details.

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.3 LTS): MIRit_0.99.10.tar.gz macOS 12.7.1 Monterey: MIRit_0.99.10.tar.gz

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

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Single Package Builder.

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.

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.3 LTS): MIRit_0.99.11.tar.gz macOS 12.7.1 Monterey: MIRit_0.99.11.tar.gz

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

PeteHaitch commented 9 months ago

Hi @jacopo-ronchi,

Thank you for submitting MIRit to Bioconductor.

Overall, the package is in very good shape and close to being ready for acceptance. Well done and thank you for making the effort, particularly with regard to the thorough documentation!

In my review below I have separated the issues into Required and Recommended points that I would ask you to address before the package can be accepted. Would you please provide line-by-line comments to my initial review so that I know what changes I'm looking for in my re-review.

Cheers, Pete

Required

diff --git a/vignettes/MIRit.Rmd b/vignettes/MIRit.Rmd
index 3f32903..1f223f9 100644
--- a/vignettes/MIRit.Rmd
+++ b/vignettes/MIRit.Rmd
@@ -246,7 +246,7 @@ Additionally, when we run these functions, we must define different arguments, n

 Following our example, let's calculate differentially expressed genes and differentially expressed miRNAs in thyroid cancer.

-```{r diffexp, eval=FALSE}
+```{r diffexp}
 ## perform differential expression for genes
 experiment <- performGeneDE(experiment,
                             group = "disease",
@@ -260,11 +260,6 @@ experiment <- performMirnaDE(experiment,
                              design = model)

-{r, echo=FALSE} -## load the example object -experiment <- loadExamples() -

If not specified, the performMirnaDE() and performGeneDE() functions will define differentially expressed genes/miRNAs as those having an adjusted p-value lower than 0.05, and an absolute log2 fold change higher than 1 (FC > 2). However, this behavior can be changed by tweaking the pCutoff parameter, that specifies the statistical significance threshold; the logFC parameter, which indicates the minimum log2 fold change that features must display for being considered as differentially expressed; and the pAdjustment parameter, which specifies the approach used for multiple testing correction (default is fdr to use the Benjamini-Hochberg method).

Advanced parameters {#param}

@@ -522,7 +517,7 @@ Given the above, MIRit allows the prediction of miRNA-target interactions via th

In our example, we are going to retrieve both predicted and validated interactions by using default settings.

-{r targets, eval=FALSE} +{r targets, results='hide'}

retrieve miRNA target genes

experiment <- getTargets(experiment)

@@ -645,7 +640,7 @@ In MIRit, the `mirnaIntegration()` function automatically performs association t

 For example, we could use the Boschloo's exact to evaluate the inverse association between miRNA and gene expression values through a simple call to `mirnaIntegration()` function.

-```{r association, eval=FALSE}
+```{r association}
 ## perform a one-sided inverse association
 exp.association <- mirnaIntegration(experiment,
                                     test = "association",
@@ -661,7 +656,7 @@ Lastly, for unpaired data, the effect of DE-miRNAs on the expression of target g

 To perform the integrative analysis through rotation gene-set tests, we must simply set `test = "fry"` when calling `mirnaIntegration()` function.

-```{r fry, eval=FALSE}
+```{r fry}
 ## perform the integrative analysis through 'fry' method
 exp.fry <- mirnaIntegration(experiment,
                             test = "fry",
@@ -742,7 +737,7 @@ Before performing TAIPA, we need to create miRNA-augmented networks. To do so, M

 In our example, we want to use the significant miRNA-target pairs that we identified in Section \@ref(correlation) to augment biological pathways retrieved from the KEGG database.

-```{r augmented_networks, eval=FALSE}
+```{r augmented_networks}
 ## create miRNA-augmented networks using KEGG pathways
 networks <- preparePathways(experiment,
                             database = "KEGG",

[^1]: At least on my 2020 M1 MacBook Air, R CMD build only takes 1.5 minutes and R CMD check is < 3 minutes.

association <- findMirnaSNPs(experiment, "Alzheimer disease")
Querying GWAS Catalog, this may take some time...
Finding genomic information of differentially expressed miRNAs...
No disease-related SNPs are present within DE-miRNA loci.

mirVariantPlot("rs2632516", association, showContext = TRUE)
Error: 'snpAssociation' must be a data.frame containing the list of SNPs occurring at DE-miRNA genes. To obtain this association you can use the 'findMirnaSNPs()' function. See ?findMirnaSNPs for details.

Recommended

[^2]: "A commonly used approach is to apply FDR and logFC cutoffs simultaneously. However this tends to favor lowly expressed genes, and also fails to control the FDR correctly.". Instead, the authors developed limma::treat() and edgeR::glmTreat(); see their documentation for further details. DESeq2 may have similar functionality but I'm not as familiar with that package.

> show(experiment)
An object of class MirnaExperiment, which extendsMultiAssayExperiment class and contains:

    - microRNA expression values: matrixarray with 371 rows and 16 columns
    - gene expression values: matrixarray with 2637 rows and 16 columns
    - samples metadata: DFrame with 16 rows and 5 columns
    - microRNA differential expression: data.frame with 371 rows and 5 columns
    - significant DE-miRNAs: character with 40 miRNA IDs
    - gene differential expression: data.frame with 2637 rows and 5 columns
    - significant genes: character with 267 gene IDs
    - microRNA targets: data.frame with 13605 rows and 6 columns
    - miRNA - gene integrative analysis: data.frame with 210 rows and 6 columns

MicroRNA and gene expression data derive from: paired samples
bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Single Package Builder.

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.

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.3 LTS): MIRit_0.99.12.tar.gz macOS 12.7.1 Monterey: MIRit_0.99.12.tar.gz

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

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 months ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Single Package Builder.

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.

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.3 LTS): MIRit_0.99.13.tar.gz macOS 12.7.1 Monterey: MIRit_0.99.13.tar.gz

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

jacopo-ronchi commented 9 months ago

Dear @PeteHaitch,

First of all I would like to thank you for the detailed and competent review of my package. I really appreciated each of your suggestions as they were extremely useful to make MIRit better.

With this new update, all your concerns have been addressed, and below you will find detailed answers to each point.


  • [x] More of the code chunks in the vignette need to be evaluated. I understand you've been battling to get package build/check under the time limits (which is very much appreciated!) but I identified a few chunks (see below) that can be safely evaluated without greatly increasing the run time1. More importantly, when I ran the code myself I found that I got slightly different results to the 'pre-computed' results that are used in the vignette, which goes to highlight the important of using evaluated code chunks as much as possible to avoid the code and documentation falling out-of-sync.

Yes, you are correct. As you point out, there were slightly different results between the output of the vignette chunks and the precomputed objects. So the vignette has been completely redesigned and every code chunk is now evaluated. This way the vignette is completely dynamic and will not be out of sync with the documentation.


  • [x] I wonder if MultiAssayExperiment should be listed under Depends rather than under Imports because the MirnaExperiment class extends the MultiAssayExperiment class. Doing so would automatically provide the MultiAssayExperiment API when a user runs library(MIRit). For example, when I was following along with the vignette, I was surprised I couldn't immediately run experments(), assays(), colData(), sampleMap(), etc. on the example MirnaExperiment.

I moved MultiAssayExperiment to Depends based on your advice.


The geneset package is on CRAN, I fixed the link in the vignette.


  • [x] Possibly related to the vignette using pre-computed results, but when I ran the through the vignette and actually evalauted the code, the section demonstrating findMirnaSNPs() and mirVariantPlot() gave an error because there were no disease-related SNPs:

In the new vignette, the examples with SNPs are now evaluated and fully functional.


  • [x] Good work adding unit tests to your package. I recommend running covr::report() on the package code to identify untested/under-tested code.

I have done this. I would also like to increase the amount of tested code, but that would increase R CMD check times. I have posted a mail to the Bioc-devel mailing list about the strangely high check times on MacOS. So for now, I am waiting for updates on this issue before implementing new tests.


  • [x] There are some warnings generated by code in the vignette, which are then included in the rendered version. I suggest taking a look at those to make sure its behaving as intended and if the warnings are unavoidable to perhaps add a comment to the vignette explaining why that is.

This update fixes warnings. Now only one chunk throws a warning, which is expected and described in the vignette.


  • [x] The limma/edgeR authors explicitly recommend against applying a logFC cutoff to the results of a DE analysis2, so performGeneDE(logFC = 1)/performMirnaDE(logFC = 1) is perhaps a 'bad' default.

Fixed, now the default option is not to include logFC cutoff.


  • [x] Possibly related to the vignette using pre-computed results, the fry example produced no statistically significant association when I ran it; is that to be expected and as you intended?

Now this chunk is evaluated and returns significant results.


  • [x] Minor: formatting of 'matrixarray' in the show,MirnaExperiment-method (see below) is perhaps not what you intended?

Formatting is now fixed!


  • [x] Minor: Suggest clarifying in the documentation that MIRit uses edgeR's quasi-likelihood framework (since edgeR also has the likelihood ratio test and exact test frameworks).

You are absolutely correct. This information has been added to both the vignette and the documentation.


  • [x] Minor: In the vignette it says, "For example, the correlation analysis performed in Section 7.1.2 revealed how miR-146b-5p, the most upregulated miRNA, is inversely correlated with the expression of DIO2,", but I could not see this result ('miR-146b-5p' doesn't appear in that section as far as I can tell).

This was fixed in the new vignette.


  • [x] Minor: For the BugReports field in the DESCRIPTION, some developers put the GitHub issues page for their package here, distinguishing 'bug reports' (i.e. issues with the package code and documentation, typically recommended to be posted to https://github.com/jacopo-ronchi/MIRit/issues) from 'user support' (typically recommended to be posted to https://support.bioconductor.org/tag/MIRit). But it's fine as it is and the choice is yours as a developer.

Ok, no problem. I changed the link in the DESCRIPTION to receive bug reports to https://github.com/jacopo-ronchi/MIRit/issues.


In summary, everything has been addressed in version 0.99.13. The only suggestion I was not able to implement was to increase the unit tests. Currently, MIRit takes 4 minutes to check on the Linux builder, but is (weirdly) much slower on MacOS (10 minutes and 30 seconds). So I wrote an email to the Bioc-devel mailing list, and some members confirmed the lower performance on MacOS. So I will wait for their response before including a more extensive test suite.

Thanks again for your valuable feedback. Jacopo

PeteHaitch commented 8 months ago

Thank you for making the requested changes, @jacopo-ronchi. I'm happy to accept MIRit into Bioconductor. Congratulations and thank you for your contribution!

Regarding the addition of unit tests increasing the check time, if you aren't aware then you might be interested to learn about 'long tests' (https://contributions.bioconductor.org/long-tests.html).

bioc-issue-bot commented 8 months ago

Your package has been accepted. It will be added to the Bioconductor nightly builds.

Thank you for contributing to Bioconductor!

Reviewers for Bioconductor packages are volunteers from the Bioconductor community. If you are interested in becoming a Bioconductor package reviewer, please see Reviewers Expectations.

lshep commented 8 months ago

The default branch of your GitHub repository has been added to Bioconductor's git repository as branch devel.

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/jacopo-ronchi.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 BiocManager::install("MIRit"). The package 'landing page' will be created at

https://bioconductor.org/packages/MIRit

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.