Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

CTSV #2663

Closed jingeyu closed 2 years ago

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

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: CTSV
Type: Package
Title: Identification of cell-type-specific spatially variable genes
        accounting for excess zeros
Version: 0.99.0
Date: 2022-05-09
Authors@R: c(person("Jinge Yu", "Developer", role = c("aut","cre"),email = "yjgruc@ruc.edu.cn"),
   person("Xiangyu Luo", "Developer", role = "aut",email = "xiangyuluo@ruc.edu.cn"))
Description: The R package CTSV implements the CTSV approach developed by Jinge Yu and Xiangyu Luo that detects cell-type-specific spatially variable genes accounting for excess zeros. CTSV directly models sparse raw count data through a zero-inflated negative binomial regression model, incorporates cell-type proportions, and performs hypothesis testing based on R package pscl. The package outputs p-values and q-values for genes in each cell type, and CTSV is scalable to datasets with tens of thousands of genes measured on hundreds of spots. CTSV can be installed in Windows, Linux, and Mac OS. 
biocViews: GeneExpression, StatisticalMethod, Regression, Spatial,
        Genetics
Depends: R (>= 4.0.0)
Imports: stats, pscl, qvalue, BiocParallel,methods,knitr
Suggests: rmarkdown, testthat
License: GPL-3
RoxygenNote: 7.2.0
Encoding: UTF-8
NeedsCompilation: yes
VignetteBuilder: knitr
vjcitn commented 2 years ago

Thanks for the submission. The vignette includes

Y is a n×G count bulk ST data matrix, where each row stands for a spot and each column represents a gene.
loc is a n×2 location matrix, where each row is a two-dimensional coordinate for the corresponding spot.
W is the cell-type-specific matrix with n×K dimensions, where K is the number of cell types.
num_core: for parallel processing, the number of cores used. If set to 1, parallel processing i

Please use a derivate of SummarizedExperiment, perhaps SpatialExperiment, to help users who may be familiar with related Bioconductor infrastructure for your application. The use of BiocParallel should be mediated through bpparam setting.

jingeyu commented 2 years ago

Thank you for your comments.

Answer to point 1: I have revised the main R function 'CTSV.R' to support the use of SpatialExperiemnt, thus the input of main function 'ctsv' are SpatialExperiment class object instead of 'Y' and 'loc'.

Answer to point 2: I have added BPPARAM parameter as input parameter of 'ctsv' function to control parallel process, details can be attached in vignette.

And I have updated DESCRIPTION, NAMESPACE, CTSV.R, CTSVexample.RData, test-ctsv.R, and vignette in my CTSV repository since the input of our function is changed. Please check it.

vjcitn commented 2 years ago

Bump the version number in DESCRIPTION whenever you make source changes.

When installing on linux I saw

6: In readLines(file) :
  incomplete final line found on '/home/stvjc/SUBMISSIONS/CTSV/DESCRIPTION'
7: roxygen2 requires Encoding: "UTF-8"

In vignette, use suppressPackageStartupMessages to wrap your library commands to reduce space taken up by attachment messages.

Running CTSV
We are now ready to run CTSV on the bulk ST data using ctsv function.

spe is a n×G count bulk ST data matrix, where each row stands for a spot and each column represents a gene.

that's from the vignette ... is it still true, or is spe a SpatialExperiment instance?

jingeyu commented 2 years ago

Thank you for your comments!

Answer to version: Apologize for my mistake. I have bumped the version number from 0.99.0 to 0.99.2 in this update version.

Answer to Linux installation: (1) I added a blank line in the end of the DESCRIPTION hoping to avoid the Warning. (2) In the DESCRIPTION file I set 'Encoding: UTF-8' and when I run 'roxygen2::roxygenise()', 'roxygen2 requires Encoding: "UTF-8"' did not appeared. Furthermore, when I install the source package on linux (x86_64-pc-linux-gnu (64-bit)) none of the warning messages listed appeared.So I have no idea why these two warnings appear.

Answer to vignette: (1). I used ’suppressPackageStartupMessages‘ in vigentte in the new version. (2). spe is actually a SpatialExperiment instance, and I revised the statement in vignette.

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

jingeyu commented 2 years ago

Thank you for the bulid report. I found two same ERRORS in 'BiocCheck' on Linux and MacOS systems separately, one is 'Maintainer must subscribe to the bioc-devel mailing list' and the other one is 'Maintainer must register at the support site'.

  1. I have successfully subscribed to the bioc-devl mailing list with the information "You have successfully confirmed your subscription request for "yjgruc@ruc.edu.cn" to the Bioc-devel mailing list.'.

  2. I have registered at the support site via mu github accout with the information in the website " Successfully signed in as 7c38eb88.".

  3. Furthermore, I bumped the version of CTSV from 0.99.2 to 0.99.3 in my github repository.

bioc-issue-bot commented 2 years ago

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

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/CTSV 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: db13bfe0ddb2e40cd9cfae8858b536a93445394e

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/CTSV 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: 8d26545af0705b0a1ca4b976e45e3598dd0e1c8e

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

jingeyu commented 2 years ago

Thank you for the bulid report!

jingeyu commented 2 years ago

Dear Bioconductor, is there anything else that I should amend?

LiNk-NY commented 2 years ago

Hi Jinge Yu, @jingeyu Thank you for your submission. Sorry for the delay in the review. I will provide a review in the next couple of days. Best regards, Marcel

LiNk-NY commented 2 years ago

Hi JingeYu, @jingeyu

Please see the review below. Best regards, Marcel


CTSV #2663

Ideally, the package would accept mainly SpatialExperiment inputs as well as matrix inputs for the counts and spatial coordinates information.

DESCRIPTION

NAMESPACE

vignettes

R

/

Warning in file(con, "w") :
  cannot open file '00LOCK-CTSV/00new/CTSV/doc/index.html': No such file or directory
Error in file(con, "w") : cannot open the connection
ERROR: installing vignettes failed

tests

covr::package_coverage()
CTSV Coverage: 26.26%
R/CTSV.R: 26.26%
bioc-issue-bot commented 2 years ago

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

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/CTSV 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: 6f7a3a04780ef5b2413c47c82c0d37a052a62d46

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

jingeyu commented 2 years ago

Hi @LiNk-NY, thank you for your review, I have addressed the points you proposed.

  1. "Ideally, the package would accept mainly SpatialExperiment inputs as well as matrix inputs for the counts and spatial coordinates information." Response: Our package mainly takes SpatialExperiment as inputs for the counts and spatial coordinates information, and the parameter 'W' in the main function 'CTSV' is the cell-type proportion matrix that is necessary for our method. And the 'num_core' is set for paralleling computation.

DESCRIPTION

  1. I have wrapped the text in the Description to a max of 80 character-width.
  2. I have added BugReports and URL fields.
  3. I have updated the R depends field to R >= 4.2.

NAMESPACE

  1. The main function is in the same case as the package i.e.,
CTSV::CTSV in the revised version.

Vignettes

  1. I have used the Bioconductor BiocStyle::html_document vignette generator in the new version.
  2. I have wrapped the text in the Description to a max of 80 character width.
  3. 'RCTD' is a typo here, it should be 'CTSV' actually, and I fixed the problem, sorry for my carelessness.
  4. I used 'assay(spe)' instead of slot in the new version.
  5. I have removed print functions.

R

  1. I have combined some input checks and there are few input checks now.
  2. I deleted all the exclamation point '!' in the R function.
  3. I deleted formalities ('please') in the messages and only provided the information necessary for the user.
  4. I have used the standard interface (assay) and avoided the use of @ in the new version.

/

  1. I deleted the bulid folder in the new version.

tests

I have improved the function coverage from 26.26% to 83.33%. covr::package_coverage() CTSV Coverage: 83.33% R/CTSV.R: 83.33%

LiNk-NY commented 2 years ago

Hi JingeYu, @jingeyu

Thank you for making those changes. It would be good to have some flexibility in the input and not restrict to only SpatialExperiment users but this mostly a design choice. Also note that in R print(K) is the same as K. Consider removing the extra print calls in the examples.

The package looks ready. Thank you for your submission.

Best regards, Marcel

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.

jingeyu commented 2 years ago

Hi JingeYu, @jingeyu

Thank you for making those changes. It would be good to have some flexibility in the input and not restrict to only SpatialExperiment users but this mostly a design choice. Also note that in R print(K) is the same as K. Consider removing the extra print calls in the examples.

The package looks ready. Thank you for your submission.

Best regards, Marcel

Hi @LiNk-NY, I will remove extra 'print' in the examples. And the input format folllowed the advice of vjcitn -- "Please use a derivate of SummarizedExperiment, perhaps SpatialExperiment, to help users who may be familiar with related Bioconductor infrastructure for your application."

Best regards, Jinge Yu

LiNk-NY commented 2 years ago

Hi JingeYu, @jingeyu

That doesn't mean you can't have both types of inputs. Some users may not have a SpatialExperiment to work with, although we expect most users do. There are many packages in Bioconductor that allow, for example, either a SummarizedExperiment or matrix as input.

Best regards, Marcel

jingeyu commented 2 years ago

Hi JingeYu, @jingeyu

That doesn't mean you can't have both types of inputs. Some users may not have a SpatialExperiment to work with, although we expect most users do. There are many packages in Bioconductor that allow, for example, either a SummarizedExperiment or matrix as input.

Best regards, Marcel

Hi Marcel, @LiNk-NY, thank your for your suggestions, and I will improve my package in the next few days!

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: "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. 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/CTSV 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: 9162e529beb9e26289c2db47b62ec716f12e683b

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/CTSV 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

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

https://bioconductor.org/packages/CTSV

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.