scverse / scverse/spatialdata

Index name not preserved after read-write for points and shapes?

Open
#1,126 6 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

Looking at this notebook: https://helenalc.github.io/SpatialData.demo/code/csama.html (CC @HelenaLC), it looks like that when we write shapes, the name of an index is lost. Probably this happens also for points.

Helena wrote in Zulip#spatialdata-devel > `spatialdata-io` dropping column? @ 💬:

I think the issue in R is that we don't have a concept of .index – the closest would be a named vector, or array with dim. names; but, an sf table like that can't have row names afaik. So there should be a column with that name... which was usually the case; just not these data.

Therefore it's important to preserve the index name.

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 with the linked notebook at helenalc.github.io/SpatialData.demo/code/csama.html and trace the read-write path for shapes, then check whether points use the same behavior. Reproduce the round trip with a named index and verify that its name is preserved for both shapes and points.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.