Bioconductor / Contributions

Contribute Packages to Bioconductor
131 stars 33 forks source link

SubcellularSpatialData #3309

Closed bhuvad closed 4 months ago

bhuvad commented 4 months 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 4 months ago

Hi @bhuvad

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: SubcellularSpatialData
Title: Annotated spatial transcriptomics datasets from 10x Xenium, NanoString CosMx and BGI STOmics.
Version: 0.99.10
Authors@R: c(
  person(given = "Dharmesh D.",
         family = "Bhuva",
         role = c("aut", "cre"),
         email = "dharmesh.bhuva@adelaide.edu.au",
         comment = c(ORCID = "0000-0002-6398-9157"))
  )
Description: This is a data package that hosts annotated sub-cellular localised datasets from the Visium, Xenium and CosMx platforms. Specifically, it hosts datasets analysed in the publication Bhuva et. al, 2023 titled "Library size confounds biology in spatial transcriptomics data". Raw transcript detections are hosted and functions to convert them to SpatialExperiment objects have been implemented.
biocViews: ExperimentHub, SpatialData, Homo_sapiens_Data, Mus_musculus_Data, LungCancerData
License: GPL (>= 3)
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
URL: https://davislaboratory.github.io/SubcellularSpatialData
BugReports: https://github.com/DavisLaboratory/SubcellularSpatialData/issues
Imports: 
    dplyr,
    hexbin,
    Matrix,
    SpatialExperiment,
    stats
NeedsCompilation: no
VignetteBuilder: knitr
Suggests: 
    ExperimentHub,
    ggplot2,
    knitr,
    rmarkdown,
    testthat (>= 3.0.0)
Depends: 
    R (>= 2.10)
LazyData: true
Config/testthat/edition: 3
lshep commented 4 months ago

When I tried to build, prettydoc is required. Please add to Suggests of your description.

bioc-issue-bot commented 4 months 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 4 months 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.

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

bioc-issue-bot commented 4 months ago

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

bioc-issue-bot commented 4 months ago

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

bioc-issue-bot commented 4 months 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 22.04.3 LTS): SubcellularSpatialData_0.99.11.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/SubcellularSpatialData to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

lshep commented 4 months ago

Thank you for the submission please see comments:

description

readme

man

bioc-issue-bot commented 4 months ago

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

bioc-issue-bot commented 4 months 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 22.04.3 LTS): SubcellularSpatialData_0.99.12.tar.gz macOS 12.7.1 Monterey: SubcellularSpatialData_0.99.12.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/SubcellularSpatialData to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bhuvad commented 4 months ago

Thank you for the submission please see comments:

description

  • [x] Please update the R dependency to 4.4
  • [x] Please set LazyData: to false

readme

  • [x] Please include bioconductor installation instructions

man

  • [x] Please include a package level man page so when a naive user tried ?SubcellularSpatialData they have some indication of how to get started.
  • [x] you documented allocateHex, allocateRegion, and allocateSqure but did not export? Should these be exported or should the documentation contain keyword{internal} to indicate internal function documentation only?

I have made all the suggested modifications. The allocate functions were meant for internal usage but I wanted to document them for future developers. I have added the keyword internal as suggested. I thank you for helping me improve the documentation of this package Lori.

bioc-issue-bot commented 4 months 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 4 months ago

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

https://bioconductor.org/packages/SubcellularSpatialData

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.