Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

dreamlet submission #2955

Closed GabrielHoffman closed 1 year ago

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

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: dreamlet
Type: Package
Title: Cohort-scale differential expression analysis of single cell data using linear (mixed) models
Version: 0.99.0
Date: 2023-03-15
Authors@R: person("Gabriel", "Hoffman", role=c("aut", "cre"), email="gabriel.hoffman@mssm.edu")
Description: Recent advances in single cell/nucleus transcriptomic technology has enabled collection of cohort-scale datasets to study cell type specific gene expression differences associated disease state, stimulus, and genetic regulation. The scale of these data, complex study designs, and low read count per cell mean that characterizing cell type specific molecular mechanisms requires a user-frieldly, purpose-build analytical framework. We have developed the dreamlet package that applies a pseudobulk approach and fits a regression model for each gene and cell cluster to test differential expression across individuals associated with a trait of interest. Use of precision-weighted linear mixed models enables accounting for repeated measures study designs, high dimensional batch effects, and varying sequencing depth or observed cells per biosample.
VignetteBuilder: knitr
License: Artistic-2.0
Encoding: UTF-8
URL: https://DiseaseNeurogenomics.github.io/dreamlet
BugReports: https://github.com/DiseaseNeurogenomics/dreamlet/issues
Suggests:
    BiocStyle,
    knitr,
    pander,
    rmarkdown,
    muscat,
    ExperimentHub,
    RUnit,
    scater,
    scuttle
biocViews: RNASeq,
    GeneExpression,
    DifferentialExpression,
    BatchEffect,
    QualityControl,
    Regression,
    GeneSetEnrichment,
    GeneRegulation,
    Epigenetics,
    FunctionalGenomics,
    Transcriptomics,
    Normalization,
    SingleCell,
    Preprocessing,
    Software
Depends:
    R (>= 4.2.0),
    ggplot2,
    variancePartition (>= 1.28.3)
Imports:
    edgeR,
    SummarizedExperiment,
    SingleCellExperiment,
    DelayedMatrixStats,
    sparseMatrixStats,
    MatrixGenerics,
    Matrix,
    methods,
    purrr,
    GSEABase,
    data.table,
    zenith (>= 0.99.13),
    mashr (>= 0.2.52),
    ashr,
    dplyr,
    BiocParallel,
    S4Vectors,
    IRanges,
    limma,
    tidyr,
    BiocGenerics,
    HDF5Array,
    DelayedArray,
    gtools,
    reshape2,
    ggrepel,
    scattermore,
    Rcpp,
    lme4,
    MASS,
    Rdpack,
    utils,
    stats
RoxygenNote: 7.2.3
RdMacros: Rdpack
SystemRequirements: C++11
LinkingTo: 
    Rcpp,
    beachmat
vjcitn commented 1 year ago

crumblr is referenced in vignettes but not declared in DESCRIPTION

vjcitn commented 1 year ago

and i can't find it. private repo?

vjcitn commented 1 year ago

it has to be in CRAN or bioconductor for dreamlet to go in. please advise.

GabrielHoffman commented 1 year ago

I have removed reference to this package in the latest push to GitHub (v0.99.1).

Reference to this package in the vignette had already been commented out, so a user would never have seen it. But now I removed it completely.

crumblr is a secondary package that I'm developing, but dreamlet does not depend on it.

vjcitn commented 1 year ago

Package .tar.gz is 11MB on my linux system. Sound right?

 dreamlet/docs/deps/bootstrap-5.1.3/fonts/memQYaGs126MiZpBA-UFUIcVXSCEkx2cmqvXlWq8tWZ0Pw86hd0Rk5hkWVAexg.woff
  dreamlet/docs/deps/bootstrap-5.1.3/fonts/memQYaGs126MiZpBA-UFUIcVXSCEkx2cmqvXlWq8tWZ0Pw86hd0Rk5hkaVQ.woff
  dreamlet/docs/deps/bootstrap-5.1.3/fonts/memQYaGs126MiZpBA-UFUIcVXSCEkx2cmqvXlWq8tWZ0Pw86hd0Rk8ZkWVAexg.woff

do you want the docs folder or should it be in .Rbuildignore?

vjcitn commented 1 year ago

https://arxiv.org/pdf/2012.02936.pdf discusses inference post-clustering. Does the package address this concern?

GabrielHoffman commented 1 year ago

1) The new version adds docs to . Rbuildignore, so tar.gz is now 4.4M on my Mac.

2) The Gao, et al. work is very interesting, but separate from the primary problem addressed here. Gao, et al. consider finding genes that are differentially expressed between two clusters. dreamlet does include this capability just for convenience, and I am well aware that the p-values are poorly calibrated.

But the primary goal of dreamlet it to identify genes differentially expressed within a single cluster, but across subjects based on a variable of interest (i.e. case/control status). I submitted my manuscript to biorxiv on Friday, but they didn't post it yet. I will link to it as soon at it's up.

Gabriel

GabrielHoffman commented 1 year ago

Preprint is now posted on biorxiv: https://doi.org/10.1101/2023.03.17.533005 and included in inst/CITATION

bioc-issue-bot commented 1 year ago

A reviewer has been assigned to your package. Learn what to expect during the review process.

IMPORTANT: Please read this documentation for setting up remotes to push to git.bioconductor.org. It is required to push a version bump to git.bioconductor.org to trigger a new build.

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 1 year 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, 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. This link will be 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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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, 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. This link will be 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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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. This link will be 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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

GabrielHoffman commented 1 year ago

Hi Vince, These warnings are almost all out of my control, these are the ones I couldn't resolve. Do you have technical suggestions on addressing them, or how to proceed?

vjcitn commented 1 year ago

these warnings should be fixable using name space discipline your reviewer should have some advice on the details

On Mon, Mar 27, 2023 at 3:48 PM Gabriel Hoffman @.***> wrote:

Hi Vince, These warnings are almost all out of my control, these are the ones I couldn't resolve. Do you have technical suggestions on addressing them, or how to proceed?

— Reply to this email directly, view it on GitHub https://github.com/Bioconductor/Contributions/issues/2955#issuecomment-1485768498, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABDI5QQTCSWGZHTCKSRZALDW6HVJLANCNFSM6AAAAAAV4RRMZY . You are receiving this because you commented.Message ID: @.***>

-- The information in this e-mail is intended only for the person to whom it is addressed. If you believe this e-mail was sent to you in error and the e-mail contains patient information, please contact the Partners Compliance  HelpLine at http://www.partners.org/complianceline http://www.partners.org/complianceline . If the e-mail was sent to you in error but does not contain patient information, please contact the sender and properly dispose of the e-mail.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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. This link will be 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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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. This link will be 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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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, 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. This link will be 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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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. This link will be 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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

GabrielHoffman commented 1 year ago

Hi @jianhong

I have resolved almost all the warnings with my package submission, but there is one I can't address. The runtime of the vignettes was exceeding the 15 min limit, so I precompiled the Rmd files as described here. This reduced the runtime, but now R warns that I don't evaluate enough of the chunks in the markdown file, since it is precompiled:

* Checking vignette directory...
    * WARNING: Evaluate more vignette chunks.
        86 code chunks / 92 total = 93% percent unevaluated
        86 non-exec code chunks (e.g., '``` r')

Either way I handle the vignette, R gives a warning.

Given this, can you overlook the warning and accept the package to Bioconductor? Or do you have any suggestions?

Best, Gabriel

jianhong commented 1 year ago

Is it possible to try smaller dataset like pbmc_small in seurat package?

GabrielHoffman commented 1 year ago

Unfortunately no. The focus of this package is variation in one expression across individuals. I have put a huge amount of work into the documentation in order to give users good intuition and reproducible examples.

lshep commented 1 year ago

Our mac builder went down sometime over night; It could be the timeout was related to it failing. Looking at the previous reports it looks like that when you were running the code it passed without warning on linux; If this is the case I would lean towards executing as much as possible within the time restraints of the linux builder

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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. This link will be 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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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. This link will be 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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

jianhong commented 1 year ago

Package 'dreamlet' Review

Thank you for submition your package to Bioconductor. The package passed check and build. However there are several things need to be fixed. Please try to answer the comments line by line when you are ready for a second review.

Code: Note: please condsider; Important: must be addressed.

The DESCRIPTION file

The NAMESPACE file

unacceptable files

General package development

R code

jianhong commented 1 year ago

Could I expect updates soon? Otherwise it will be closed because no updates within 30 days.

GabrielHoffman commented 1 year ago

Thank you for following up. I have made the changes you requested, but I'm still testing after updating some package dependencies that I also manage. I hope to submit this latest version within a week

Gabriel

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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, 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. This link will be 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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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, 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. This link will be 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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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, 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. This link will be 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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

jianhong commented 1 year ago

Could I expect the error fix soon?

GabrielHoffman commented 1 year ago

Thanks for following up. I fixed the issues with the dependencies

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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. This link will be 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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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, 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. This link will be 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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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. This link will be 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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.