New reader for G4X datasets (Singular Genomics) #281
+761
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
👋 Hello @scverse/spatialdata and community,
I would like to contribute the initial version of a
spatialdata-io
reader for Singular Genomics G4X datasets that I recently developed for internal use (I work at Singular), and now for the spatial community. It is still experimental and not fully battle-tested, but I tried to keep the API consistent with the other readers as much as possible. However, there are few key additions I made to streamline use with our datasets:Notable features
g4x(..., mode="append")
parameter. The user can also choosemode="overwrite"
to turn this off. The constructedSpatialData
is also re-read from disk automatically to fully take advantage of lazy loading.SpatialData
object or a list of them accordingly.Additional Dependencies
.jp2
,j2k
) format and require theglympur
package to readMisc.
Are there any other pieces I should have in this PR? Devs please let me know, I'm happy to add them. Here are relevant ones I can think of:
@injectdocs
decorator properly)spatialdata-io
CLI compatibility