scverse / scverse/spatialdata

Bug with `INSTANCE_KEY` for points?

Open
#217 0 comments 0 reactions 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

For the design doc, for points elements we have

It MAY contains additional information in dask.dataframe.DataFrame().attrs["spatialdata_attrs"], specifically:

"instance_key": the column name of the table where unique instance ids that this point refers to are stored, if available.

I think this is not sufficient to identify instances, we need also a region_key column, since there could be multiple regions elements that share the same indices for identifying the instances.

We need to:

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 reviewing the design document's points-element schema and the existing schema definition, then inspect issue #218 for the planned relationship validation. Done means the schema includes the required region key, the design document is updated, tests cover the relationship, and the validation is added.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.