scverse / scverse/spatialdata

Elements should be validated before starting to write

Open
#804 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
394
Forks
95
Avg merge
4d 3h
Merged PRs (30d)
7

Description

Is your feature request related to a problem? Please describe.
I am writing a large sdata object I created to disk. It wrote the image for 12 min and then failed because my adata.obs[region_key] was not categorical.

Describe the solution you'd like
All the validations should happen before we start writing.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the write path for a large sdata object and locating the existing element validations. Determine where validation currently occurs relative to disk writes. Done means invalid data, such as a non-categorical adata.obs[region_key], fails before any element begins writing.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.