Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

scQTLtools #3515

Open XFWuCN opened 1 month ago

XFWuCN commented 1 month ago

Hello Bioconductor team, I am submitting my R package {scQTLtools} for consideration for Bioconductor release.

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 month ago

Hi @XFWuCN

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: scQTLtools
Type: Package
Title: An R package for single-cell eQTL analysis and visualization
Version: 0.99.0
Authors@R: c(
    person(given = "Xiaofeng", 
 family = "Wu",    
 email = "1427972815@qq.com", 
 role  = c("aut", "cre", "cph"), 
 comment = c(ORCID = "0009-0003-6254-5575")),
    person(given = "Xin",      
 family = "Huang", 
 email = "1097567240@qq.com",   
 role  = c("aut", "cph")),
    person(given = "Jingtong", 
 family = "Kang",  
 email = "1203178107@qq.com",     
 role = "com"),
    person(given = "Siwen",    
 family = "Xu",    
 email = "siwxu@gdpu.edu.cn",      
 role  = c("aut", "cph"))
    )
Description: This package specializes in analyzing and visualizing eQTL at the
    single-cell level. It can read gene expression matrices or Seurat data, 
    along with genotype data. It offers a function for cis-eQTL analysis to 
    detect eQTL within a given range, and another function to fit models with
    three methods. Using this package, users can also generate single-cell
    level visualization result.
Depends: R (>= 4.4.1.0)
Imports:
    ggplot2(>= 3.5.1),
    Matrix (>= 1.7-0),
    stats (>= 4.4.1),
    progress(>= 1.2.3),
    stringr(>= 1.5.1),
    dplyr(>= 1.1.4),
    SeuratObject(>= 5.0.2),
    methods(>= 4.4.1),
    magrittr(>= 2.0.3),
    patchwork(>= 1.2.0),
    DESeq2 (>= 1.45.3),
    AnnotationDbi(>= 1.67.0),
    VGAM (>= 1.1-11),
    limma (>= 3.61.9),
    biomaRt(>= 2.61.3),
    org.Hs.eg.db (>= 3.19.1),
    org.Mm.eg.db (>= 3.19.1),
    gamlss (>= 5.4-22)
Suggests: 
    BiocStyle,
    knitr,
    rmarkdown,
    testthat (>= 3.2.1.1)
License: MIT + file LICENSE
URL: https://github.com/XFWuCN/scQTLtools
VignetteBuilder: knitr
BugReports: https://github.com/XFWuCN/scQTLtools/issues
biocViews: Software,GeneExpression,GeneticVariability,SNP,
        DifferentialExpression,GenomicVariation,VariantDetection,Genetics,
        FunctionalGenomics,SystemsBiology,Regression,SingleCell,Normalization,
        Visualization
Encoding: UTF-8
RoxygenNote: 7.3.2
LazyData: false
Config/testthat/edition: 3
lshep commented 4 weeks ago

If this package is working with Single Cell Data, it should work with the standard Bioconductor class SingleCellExperiment. See https://contributions.bioconductor.org/important-bioconductor-package-development-features.html particularly interop with Bioconductor classes.

lshep commented 4 weeks ago

It will also be necessary to provide an abstract/intro section in your vignette that provides motivation for inclusion in Bioconductor and a review and comparison to existing Bioconductor packages with similar functionality or scope.

XFWuCN commented 3 weeks ago

If this package is working with Single Cell Data, it should work with the standard Bioconductor class SingleCellExperiment. See https://contributions.bioconductor.org/important-bioconductor-package-development-features.html particularly interop with Bioconductor classes.

Thank you for the review, we're working on it.

XFWuCN commented 1 week ago

If this package is working with Single Cell Data, it should work with the standard Bioconductor class SingleCellExperiment. See https://contributions.bioconductor.org/important-bioconductor-package-development-features.html particularly interop with Bioconductor classes.

Hi, we‘ve edit the createQTLObject() function and vignette of our R package according to the modification requirements, and we're done with it.

XFWuCN commented 1 week ago

To be specific,

  1. We added the possibility to input a SingleCellExperiment object as genedata parameter of the createQTLObject() function, and I made corresponding modifications in the header comment, DESCRIPTION, vignette example and test-createQTLObject.

  2. I added a motivation for inclusion in Bioconductor in the introduction section of my vignette.

  3. I added a comparison section for compare our R package with existing Bioconductor packages offering similar functionality. We found that only find iBMQ packge performs eQTL identification in Bioconductor.

Thank you for the review.

bioc-issue-bot commented 1 week 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 1 week 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 24.04.1 LTS): scQTLtools_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/scQTLtools to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 5 days ago

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