Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tpSVG #3264

Closed
10 tasks done
boyiguo1 opened this issue Dec 28, 2023 · 28 comments
Closed
10 tasks done

tpSVG #3264

boyiguo1 opened this issue Dec 28, 2023 · 28 comments
Assignees
Labels
3a. accepted will be ingested into Bioconductor daily builder for distribution OK

Comments

@boyiguo1
Copy link

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 understand that by submitting my package to Bioconductor,
    the package source and all review commentary are visible to the
    general public.

  • I have read the Bioconductor Package Submission
    instructions. My package is consistent with the Bioconductor
    Package Guidelines.

  • I understand Bioconductor Package Naming Policy and acknowledge
    Bioconductor may retain use of package name.

  • I understand that a minimum requirement for package acceptance
    is to pass R CMD check and R CMD BiocCheck with no ERROR or WARNINGS.
    Passing these checks does not result in automatic acceptance. The
    package will then undergo a formal review and recommendations for
    acceptance regarding other Bioconductor standards will be addressed.

  • My package addresses statistical or bioinformatic issues related
    to the analysis and comprehension of high throughput genomic data.

  • I am committed to the long-term maintenance of my package. This
    includes monitoring the support site for issues that users may
    have, subscribing to the bioc-devel mailing list to stay aware
    of developments in the Bioconductor community, responding promptly
    to requests for updates from the Core team in response to changes in
    R or underlying software.

  • I am familiar with the Bioconductor code of conduct and
    agree to abide by it.

I am familiar with the essential aspects of Bioconductor software
management, including:

  • The 'devel' branch for new packages and features.
  • The stable 'release' branch, made available every six
    months, for bug fixes.
  • Bioconductor version control using Git
    (optionally via GitHub).

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
Copy link
Collaborator

Hi @boyiguo1

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: tpSVG
Title: Thin plate models to detect spatially variable genes 
Version: 0.99.1
Authors@R: c(
    person("Boyi", "Guo",
 email = "boyi.guo.work@gmail.com",
 role = c("aut", "cre"),
 comment = c(ORCID = "0000-0003-2950-2349")),
    person("Lukas M.", "Weber", 
 email = "lukas.weber.edu@gmail.com", 
 role = c("ctb"), 
 comment = c(ORCID = "0000-0002-3282-1730")), 
    person("Stephanie C.", "Hicks", 
 email = "shicks19@jhu.edu", 
 role = c("aut"), 
 comment = c(ORCID = "0000-0002-7858-0231")))
Description: The goal of `tpSVG` is to detect and visualize spatial variation in
  the gene expression for spatially resolved transcriptomics data analysis.
  Specifically, `tpSVG` introduces a family of count-based models, with 
  generalizable parametric assumptions such as Poisson distribution or 
  negative binomial distribution. In addition, comparing to currently 
  available count-based model for spatially resolved data analysis, the 
  `tpSVG` models improves computational time, and hence greatly improves 
  the applicability of count-based models in SRT data analysis. 
License: MIT + file LICENSE
URL: https://github.com/boyiguo1/tpSVG
BugReports: https://github.com/boyiguo1/tpSVG/issues
biocViews: 
    Spatial, 
    Transcriptomics, 
    GeneExpression, 
    Software
Encoding: UTF-8
Depends: 
    mgcv,
    R (>= 4.3)
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
Imports: 
    BiocParallel,
    MatrixGenerics,
    methods,
    SingleCellExperiment,
    SpatialExperiment,
    stats,
    SummarizedExperiment
Suggests: 
    BiocStyle,
    knitr,
    nnSVG,
    rmarkdown,
    scran,
    scuttle,
    STexampleData,
    escheR,
    ggpubr,
    colorspace,
    BumpyMatrix
VignetteBuilder: knitr

@bioc-issue-bot bioc-issue-bot added the 1. awaiting moderation submitted and waiting clearance to access resources label Dec 28, 2023
@lshep lshep added the pre-check passed pre-review performed and ready to be added to git label Jan 9, 2024
@bioc-issue-bot
Copy link
Collaborator

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 bioc-issue-bot added pre-review on bioconductor git and access to on demand build but not assigned reviewer until build report clean and removed 1. awaiting moderation submitted and waiting clearance to access resources pre-check passed pre-review performed and ready to be added to git labels Jan 9, 2024
@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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: "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 Single Package Builder:
macOS 12.7.1 Monterey: tpSVG_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/tpSVG to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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: "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 Single Package Builder:
macOS 12.7.1 Monterey: tpSVG_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/tpSVG to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@boyiguo1
Copy link
Author

@lshep I apologize for tagging you. I believe the the package builder warning is a false positive.

In the previous two build reports build report for 0.99.2 and build report for 0.99.3, an outstanding warning message in Check is associated with bioconductor software dependencies.

  • Checking for Bioconductor software dependencies...
    * WARNING: No Bioconductor dependencies detected; consider a CRAN
    submission.

IMO, the package depends on SpatialExperiment either via "Imports"(0.99.2) or "Depends" (0.99.3).

If this is a false positive, I'm happy to create a issue and document it in BiocCheck. Otherwise, I would appreciate any of your input.

Thank you so much!

Best,
Boyi

@lshep
Copy link
Contributor

lshep commented Jan 10, 2024

Yes please open an issue on BiocCheck if you think it is a false positive. It was recently added this past week and may need some tweaking.

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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: "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 Single Package Builder:
macOS 12.7.1 Monterey: tpSVG_0.99.5.tar.gz
Linux (Ubuntu 22.04.2 LTS): tpSVG_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/tpSVG to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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:
macOS 12.7.1 Monterey: tpSVG_0.99.6.tar.gz
Linux (Ubuntu 22.04.2 LTS): tpSVG_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/tpSVG to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@boyiguo1
Copy link
Author

Hi,

I wonder if there is a timeline for when the peer-review would be starting. I would be extremely grateful for this information so that I could plan for manuscript submission, etc.

I understand that there are a lot unseen efforts going on, and I really appreciate all!

Sincerely,
Boyi

@lshep
Copy link
Contributor

lshep commented Jan 29, 2024

We try to look and moderate once a week or every other week. I will look at assigning a reviewer likely later today or tomorrow at the latest. Sorry for the inconvenience.

@boyiguo1
Copy link
Author

Got it. Thanks for sharing this information with me. It is very helpful for me to plan for other efforts.

I really appreciate the Bioconductor team for the responsiveness and huge efforts putting into to running and maintaining a such valuable community!!!

@lshep lshep added 2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place and removed pre-review on bioconductor git and access to on demand build but not assigned reviewer until build report clean labels Jan 30, 2024
@bioc-issue-bot
Copy link
Collaborator

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

@lshep
Copy link
Contributor

lshep commented Feb 5, 2024

We strongly advise adding unit tests to check whether the function is behaving as expected.
In your intro_to_tpSVG could you expand the intro to provide comparisons to existing packages like nnSVG on how this package differs.

@boyiguo1
Copy link
Author

boyiguo1 commented Feb 5, 2024

Sounds great! I think I would be able to do that. I'm looking for about 3-week-ish turnaround time for the unit tests and comparison, if this is okay.

@lshep
Copy link
Contributor

lshep commented Feb 5, 2024

yes. thank you.

@lshep
Copy link
Contributor

lshep commented Feb 5, 2024

also completely optionally but considering the second vignette is so short it might be worth just adding as a supplemental section at the end of the intro vignette

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@boyiguo1
Copy link
Author

@lshep Thanks for your patience! I've addressed the previous comments via a recent PR (boyiguo1/tpSVG#14)

We strongly advise adding unit tests to check whether the function is behaving as expected.

I've initiated some unit tests to check if the error prevention for arguments.

In your intro_to_tpSVG could you expand the intro to provide comparisons to existing packages like nnSVG on how this package differs.

I've added the a paragraph in the vignette explains the innovation of our package, tpSVG, which provides a scalable and flexible framework to model count data instead of log-transformed count. A specific example is given comparing the gene ranking from nnSVG (modeling log-transformed gene counts with Gaussian process model ) and from tpSVG (modeling gene counts with thin plate regression spline), which results different inference results.

also completely optionally but considering the second vignette is so short it might be worth just adding as a supplemental section at the end of the intro vignette

I have placed the shorter vignette to the end of the intro vignette.

Thank you very much!

@lshep lshep added 3a. accepted will be ingested into Bioconductor daily builder for distribution and removed 2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place labels Mar 5, 2024
@bioc-issue-bot
Copy link
Collaborator

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
Copy link
Contributor

lshep commented Mar 7, 2024

The default branch of your GitHub repository has been added to Bioconductor's
git repository as branch devel.

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

https://bioconductor.org/packages/tpSVG

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.

@lshep lshep closed this as completed Mar 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3a. accepted will be ingested into Bioconductor daily builder for distribution OK
Projects
None yet
Development

No branches or pull requests

3 participants