Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

TREG #2576

Closed lahuuki closed 2 years ago

lahuuki commented 2 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 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 2 years ago

Hi @lahuuki

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: TREG
Title: Tools for finding Total RNA Expression Genes in single nucleus RNA-seq
    data
Version: 0.99.0
Date: 2022-03-21
Authors@R: 
    c(person(given = "Louise",
 family = "Huuki",
 role = c("aut", "cre"),
 email = "lahuuki@gmail.com",
 comment = c(ORCID = "0000-0001-5148-3602")),
    person("Leonardo", "Collado-Torres", role = c("ctb"), 
    email = "lcolladotor@gmail.com", comment = c(ORCID = "0000-0003-2140-308X"))
    )
Description: RNA abundance and cell size parameters could improve RNA-seq
    deconvolution algorithms to more accurately estimate cell type proportions
    given the different cell type transcription activity levels. A Total RNA
    Expression Gene (TREG) can facilitate estimating total RNA content using
    single molecule fluorescent in situ hybridization (smFISH). We developed a
    data-driven approach using a measure of expression invariance to find
    candidate TREGs in postmortem human brain single nucleus RNA-seq. This R
    package implements the method for identifying candidate TREGs from
    snRNA-seq data.
License: Artistic-2.0
URL: https://github.com/LieberInstitute/TREG,
    http://research.libd.org/TREG/
BugReports: https://support.bioconductor.org/t/TREG
biocViews: Software, SingleCell, RNASeq, GeneExpression, Transcriptomics,
    Transcription, Sequencing
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.1.2
Depends: 
    R (>= 4.2),
    SummarizedExperiment
Suggests:
    BiocFileCache,
    BiocStyle,
    dplyr,
    ggplot2,
    knitr,
    pheatmap,
    sessioninfo,
    RefManageR,
    rmarkdown,
    testthat (>= 3.0.0),
    tibble,
    tidyr,
    SingleCellExperiment
Config/testthat/edition: 3
Imports: 
    Matrix,
    purrr,
    rafalib
VignetteBuilder: knitr
PeteHaitch commented 2 years ago

Super minor comment about the package name: I initially thought this package was concerned with Regulatory T cells, which are widely known as "Tregs" (pronounced "T-regs"). Don't know if that's worth worrying about.

vjcitn commented 2 years ago

The vignette proceeds without defining TREG until reader has passed a few screens. Because "Treg" is used in immunology to refer to regulatory T cells this is potentially confusing. The vignette title should be changed to spell out the abbreviation in situ: "How to find Total RNA Expression Genes (TREGs)"

lcolladotor commented 2 years ago

We are thinking of changing the package name. Should we close this issue and re-submit if we do that?

lshep commented 2 years ago

Yes that would be the easiest. Especially since its still in pre-check

lshep commented 2 years ago

Just reference this issue so we know to add pre-check passed

lcolladotor commented 2 years ago

Hi everyone!

Thanks for the feedback! We've decided to keep the TREG name for now. We:

If you think that we should still change the package name, please let us know. However, we think that the different pronunciation and capitalization could help (plus the note and clear vignette title). Other options we considered would use camel-case and/or not be easy to pronounce:

Best, Leo

Message co-authored-by with @lahuuki.

bioc-issue-bot commented 2 years 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 2 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. 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/TREG to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

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

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

bioc-issue-bot commented 2 years ago

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

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

bioc-issue-bot commented 2 years ago

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

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

lshep commented 2 years ago

Thank you for your submission. Please find the two minor comments:

Other

Data / sce_zero_test.Rd

Neither of these currently prevent acceptance but are strongly encouraged.

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

The master branch of your GitHub repository has been added to Bioconductor's git repository.

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/lahuuki.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("TREG"). The package 'landing page' will be created at

https://bioconductor.org/packages/TREG

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.

lahuuki commented 2 years ago

Updated the docs for sce_zero_test to reflect that it is simulated data. Thanks for the feedback @lshep ! 😊