Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

SpatialExperimentIO #3370

Open estellad opened 7 months ago

estellad commented 7 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 7 months ago

Hi @estellad

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: SpatialExperimentIO
Title: Read in Xenium, CosMx, MERSCOPE or STARmapPLUS data as SpatialExperiment object
Version: 0.99.0
Authors@R: c(
    person("Yixing E.", "Dong", 
        email = "estelladong729@gmail.com", 
        role = c("aut", "cre"), 
        comment = c(ORCID = "0009-0003-5115-5686")))
URL: https://github.com/estellad/SpatialExperimentIO
BugReports: https://github.com/estellad/SpatialExperimentIO/issues
Description: Read in imaging-based spatial transcriptomics technology data. Current available modules are for Xenium by 10X Genomics, CosMx by Nanostring, MERSCOPE by Vizgen, or STARmapPLUS from Broad Institute. You can choose to read the data in as a SpatialExperiment or a SingleCellExperiment object. 
License: Artistic-2.0
Encoding: UTF-8
VignetteBuilder: knitr
Roxygen: list(markdown = TRUE)
Imports: 
  DropletUtils,
  SpatialExperiment,
  SingleCellExperiment,
  methods,
  utils
Suggests: 
  knitr, 
  rmarkdown, 
  testthat (>= 3.0.0), 
  BiocStyle
biocViews:
  DataRepresentation, 
  DataImport, 
  Infrastructure, 
  Transcriptomics, 
  SingleCell, 
  Spatial,
  GeneExpression
RoxygenNote: 7.3.1
Config/testthat/edition: 3
bioc-issue-bot commented 7 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 7 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): SpatialExperimentIO_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/SpatialExperimentIO to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

lshep commented 7 months ago

Please resolve ERRORs before a formal reviewer is assigned

bioc-issue-bot commented 7 months ago

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

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

bioc-issue-bot commented 7 months ago

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

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

bioc-issue-bot commented 7 months ago

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

DarioS commented 7 months ago

Good work. Some minor issues.

SpatialExperimentIO 0.0.99 Initial CRAN submission.

Also, version number is not one which is associated to the package.

readCosmxSXE <- function(dirname = dirname, return_type = "SPE", ...
if(!return_type %in% c("SPE", "SCE")){
lshep commented 4 months ago

@estellad may we expect updates based on the reviewers comments soon?

bioc-issue-bot commented 2 months ago

This issue is being closed because there has been no progress for an extended period of time. You may reopen the issue when you have the time to actively participate in the review / submission process. Please also keep in mind that a package accepted to Bioconductor requires a commitment on your part to ongoing maintenance.

Thank you for your interest in Bioconductor.

estellad commented 2 months ago

Dear Lori @lshep and Dario @DarioS,

I am very sorry for my delayed response. Had some intense months with my PhD, and now I have addressed all the comments Dario gave before. I also added a new function per-user request for seqFISH. The new function is readSeqfishSXE(), and it is tested. Could you please have a look and re-open this package submission?

Once re-opened, I will try to push to devel branch to trigger a version bump.

Sincerely, Estella

bioc-issue-bot commented 2 months ago

Dear @estellad ,

We have reopened the issue to continue the review process. Please remember to push a version bump to git.bioconductor.org to trigger a new build.

bioc-issue-bot commented 2 months ago

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

vjcitn commented 2 months ago

Hi -- I haven't looked too closely at the package but wanted to check in on a couple of concepts. First, there is readXenium in the SpatialFeatureData package and as far as I know the SpatialFeatureExperiment can be coerced to SpatialExperiment. Is there a need for xenium handling in this new package? Second, the xenium handling seemed to make a specific assumption about the hdf5 representation of the quantifications? Is that right? In some outputs I've seen, a matrix market format is used in a .tar.gz file. We should try to consolidate our solutions for IO -- there is BiocIO and TENxIO that address related issues. @LiNk-NY may have a look. Thanks for the submission, do check around in other packages to see whether related functionality is already available, and if it is, please reach out to the contributors to see how we can consolidate/enhance our offerings.

estellad commented 2 months ago

Hi Vince @vjcitn ,

Nice to hear from you!

SpatialExperimentIO is created under the discussion threads at https://github.com/drighelli/SpatialExperiment/issues/126. and https://github.com/drighelli/SpatialExperiment/pull/144

Indeed, I have noticed SpatialFeatureExperiment allows the coercion to SPE class. However, the aim here is to keep a minimal cell-level SPE object, rather than also retaining information at transcript-level. Here I quote myself and others in the thread:

October 6 2023: "I tried using MoleculeExperiment (ME) read in these new imaging technology data and coerce them to SPE, but the process is a long and bulky. Here these functions directly read in the data as SPE at single-cell level (rather than ME at transcript level and then SPE at single-cell level)."

Screenshot 2024-09-03 at 18 22 38

Regarding the .h5 input or the matrix folder input, SpatialExperimentIO::readXeniumSXE() has followed the previous Visium reader's implementation in SpatialExperiment::read10xVisium(). That is, the function allows for either input format of .h5 or matrix folder. In a recent issue I opened, we agreed that it would be handy to bring back the flexibility of .h5 input file in VisiumIO::TENxVisium().

Please let me know if you have other suggestions!

Sincerely, Estella

vjcitn commented 2 months ago

Thanks, I didn't look that far back in the record. Carry on, I may have some more comments later. Thanks for prompt response.

bioc-issue-bot commented 2 months ago

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

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