Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

methodical #3169

Closed richardheery closed 8 months ago

richardheery commented 1 year 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 1 year ago

Hi @richardheery

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: methodical
Title: Discovering genomic regions where methylation is strongly associated with transcriptional activity
Version: 0.99.0
Authors@R: 
    person("Richard", "Heery", , "richardheery@gmail.com", role = c("aut", "cre"),
 comment = c(ORCID = "0000-0001-8067-3114"))
Description: DNA methylation is generally considered to be associated with transcriptional silencing. However, comprehensive, genome-wide investigation of this relationship requires the evaluation of
    potentially millions of correlation values between the methylation of individual genomic loci and expression of associated transcripts in a relatively large numbers of samples.  
    Methodical makes this process quick and easy while keeping a low memory footprint. It also provides a novel method for identifying regions where a number of methylation sites are consistently strongly 
    associated with transcriptional expression. In addition, Methodical enables housing DNA methylation data from diverse sources (e.g. WGBS, RRBS and methylation arrays) with a common framework, 
    lifting over DNA methylation data between different genome builds and creating base-resolution plots of the association between DNA methylation and 
    transcriptional activity at transcriptional start sites. 
License: GPL (>= 3)
BugReports: https://support.bioconductor.org/tag/methodical
biocViews: DNAMethylation, Transcription, MethylationArray, Software
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.2
Depends: 
    GenomicRanges,
    ggplot2,
    R (>= 2.10),
    SummarizedExperiment
LazyData: false
Imports: 
    Biostrings,
    BSgenome,
    cowplot,
    data.table,
    DelayedArray,
    doParallel,
    dplyr,
    foreach,
    GenomeInfoDb,
    HDF5Array,
    IRanges,
    RcppRoll,
    rhdf5,
    rtracklayer,
    S4Vectors,
    scales,
    tibble,
    tidyr
Suggests: 
    AnnotationHub,
    BSgenome.Athaliana.TAIR.TAIR9,
    BSgenome.Hsapiens.UCSC.hg38,
    knitr,
    methrix,
    rmarkdown
VignetteBuilder: knitr
lshep commented 1 year ago

It looks like you are using kallisto in some functionality but it is not listed as a system dependency. See http://contributions.bioconductor.org/description.html#description-sysdep
If files are downloaded from external sources (like illumina, gencode, etc) we highly recommend using caching mechanism to help users with subsequent runs and to be able to use offline. See BiocFileCache.

richardheery commented 1 year ago

I've added kallisto as a system dependency in the description and also an INSTALL file stating where it can be downloaded from. The only call to download a file is in an example which isn't run (for the kallisto_index function). Would it still be better to cache this file?

bioc-issue-bot commented 12 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 12 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Build System.

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.

The following are build products from R CMD build on the Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): methodical_0.99.0.tar.gz macOS 12.6.5 Monterey: methodical_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/methodical to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

lshep commented 12 months ago

You use BSgenome.Hsapiens.UCSC.hg19 in your man pages but currently do not list it in the Suggest of your package DESCRIPTION. Please make the changes to fix the ERROR in the build report before a reviewer is assigned to the package

bioc-issue-bot commented 12 months ago

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

bioc-issue-bot commented 12 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Build System.

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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): methodical_0.99.1.tar.gz macOS 12.6.5 Monterey: methodical_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/methodical to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 12 months ago

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

bioc-issue-bot commented 12 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Build System.

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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): methodical_0.99.2.tar.gz macOS 12.6.5 Monterey: methodical_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/methodical to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 12 months ago

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

richardheery commented 11 months ago

Hi Dario,

I'm just in the process of adding another vignette, which should be finished over the next day or two.

Cheers,

Richard

bioc-issue-bot commented 11 months ago

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

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 Build System.

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 Bioconductor Build System: macOS 12.6.5 Monterey: methodical_0.99.3.tar.gz Linux (Ubuntu 22.04.2 LTS): methodical_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/methodical 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: a0210bc670b0580ea8cf83baf76043aaa1584553

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 Build System.

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 Bioconductor Build System: macOS 12.6.5 Monterey: methodical_0.99.4.tar.gz Linux (Ubuntu 22.04.2 LTS): methodical_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/methodical 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: 1d57e48685a82d472e30fb85b33593c7ebc8c648

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 Build System.

On one or more platforms, the build results were: "TIMEOUT". 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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): methodical_0.99.5.tar.gz macOS 12.6.5 Monterey: methodical_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/methodical to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

richardheery commented 11 months ago

Hello,

The only issue I seem to be having is a timeout due to some of the examples taking a while to run. Could we still add it to the manifest and I'll find some faster examples?

bioc-issue-bot commented 11 months ago

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

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 Build System.

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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): methodical_0.99.6.tar.gz macOS 12.6.5 Monterey: methodical_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/methodical to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

richardheery commented 11 months ago

@lshep I haven't received any feedback yet, but I'm passing all checks now. I just have one warning as I call library inside some of my code. I think this is justified since I do this while setting up a cluster wrapping the call in suppressMessages as I don't want to print the package startup messages on each node to the user.

DarioS commented 11 months ago

The methodical package provides a set of analyses for DNA methylation data. It largely does not conform to the development guidlines set out in the Package Developer's Guide which is the second check box of the initial checklist above.

Downloads of files and external data from the web should be avoided.

transcript_annotation = rtracklayer::import.gff3("gencode.v38.annotation.gff3.gz")

This should be obtained via AnnotationHub.

knitr::opts_chunk$set(collapse = TRUE, comment = "#>", eval = FALSE)

Please change eval to TRUE and resubmit the package.

> download.file("https://zenodo.org/record/8422703/files/mcrpc_transcript_counts.tsv.gz", destfile = "mcrpc_transcript_counts.tsv.gz")
trying URL 'https://zenodo.org/record/8422703/files/mcrpc_transcript_counts.tsv.gz'
Content type 'application/octet-stream' length 13824482 bytes (13.2 MB)
downloaded 13.2 MB

> mcrpc_transcript_counts = data.frame(data.table::fread("mcrpc_transcript_counts.tsv.gz"), row.names = 1)
Error in data.table::fread("mcrpc_transcript_counts.tsv.gz") : 
  To read gz and bz2 files directly, fread() requires 'R.utils' package which cannot be found. Please install 'R.utils' using 'install.packages('R.utils')'.
  genomic_regions_starts[on_plus] = genomic_regions_starts[on_plus] - upstream
  genomic_regions_starts[on_minus] = genomic_regions_starts[on_minus] - downstream
  genomic_regions_ends[on_plus] = genomic_regions_ends[on_plus] + downstream
  genomic_regions_ends[on_minus] = genomic_regions_ends[on_minus] + upstream

which is already available in GenomicRanges as the promoters or perhaps flank function.

Major revisions required.

bioc-issue-bot commented 11 months ago

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

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 Build System.

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.

The following are build products from R CMD build on the Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): methodical_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/methodical 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: addad7d46f9bcbc5362e573eb96f8c54caeaefd3

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 Build System.

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.

The following are build products from R CMD build on the Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): methodical_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/methodical 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: a26f71bd74818d8706e1061400ff9aa0e578cc45

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 Build System.

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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): methodical_0.99.9.tar.gz macOS 12.6.5 Monterey: methodical_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/methodical 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: 5e32451df8de281b79e26c026d97335a1b93d58a

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 Build System.

On one or more platforms, the build results were: "TIMEOUT, skipped, 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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): methodical_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/methodical 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: 7080f44d52fe5c92c85e974380b7beb68869f7a2

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 Build System.

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 Bioconductor Build System: macOS 12.6.5 Monterey: methodical_0.99.13.tar.gz Linux (Ubuntu 22.04.2 LTS): methodical_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/methodical to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

richardheery commented 11 months ago

Thanks for your feedback @DarioS .

I think I have addressed most of your comments now:

. I changed the output of vignettes to BiocStyle::html_document and added chunks for installing the package . I replaced = with <- for variable assignment. . I now use camelCase for function names. I left internal variables used by functions in snake_case as I found the code became difficult to read otherwise. . The WGBS and RNA-seq count datasets are now donwloaded from the TumourMethData ExperimentHub package. . I am now using AnnotationHub to retrieve the transcript annotation used by the vignette. . I changed the vignette options so that all code is evaluated. . I added dependencies for DESeq2 and R.utils . For each function, I now check the class of each input variable using is(). . Parallelization now makes use of BiocParallel . I removed the expand_granges() function since GenomicRanges::promoters() can be used to achieve the same thing.

I still have some warnings regarding the use of suppressWarnings(), but I think this should be retained as otherwise thousands of warnings can be printed to the user's screen.

Let me know if there is anything else you think should be addressed.

DarioS commented 11 months ago
> head(tubb6_cpg_meth_transcript_cors)
data frame with 0 columns and 0 rows
> 
> # Extract the location of the TSS from the results
> attributes(tubb6_cpg_meth_transcript_cors)$tss_range
NULL
lshep commented 9 months ago

@richardheery did you see the above comment on re-review and may we expect changes soon?

richardheery commented 9 months ago

Hi, sorry I was very busy with the submission of a paper, but I should be able to address the comments and resubmit within the next week or so.

bioc-issue-bot commented 9 months ago

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

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: "TIMEOUT, skipped". 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: ERROR before build products produced.

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/methodical 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: aa983192921072a12a55aa65e43f3e2d502eab02

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

The following are build products from R CMD build on the Single Package Builder: ERROR before build products produced.

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/methodical 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: 943980e2671e5df994daa2ea25e2796c2989a728

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

The following are build products from R CMD build on the Single Package Builder: ERROR before build products produced.

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/methodical 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: fa49d97f3ac334c9a625fa921dd2b0879b64c619

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: "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: methodical_0.99.17.tar.gz Linux (Ubuntu 22.04.2 LTS): methodical_0.99.17.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/methodical 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: 1d9bbfd053fa8edea94d98e645d89072f91f47ea

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: "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: methodical_0.99.18.tar.gz Linux (Ubuntu 22.04.2 LTS): methodical_0.99.18.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/methodical 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: 92f30754a30fc34fe0915840d7e386cef188dec3

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: "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: methodical_0.99.19.tar.gz Linux (Ubuntu 22.04.2 LTS): methodical_0.99.19.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/methodical 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: 83fb5a4c48e52f0774c80b880509c9a2927671b9