astronomy-commons / astronomy-commons/lsdb
Our Join method is different to pandas Join
- Dominant language
- Python
- Stars
- 55
- Forks
- 26
- Avg merge
- 4d 1h
- Merged PRs (30d)
- 8
Description
We overload the pandas `join` method, using it for our spatial join. Instead, any traditional joining is done using the `merge` function. Users get confused with differences between our behavior and pandas, especially when this will give an incorrect result if users expect to get a full table join instead of a spatial one. We could consider renaming our methods, or making it more clear to users that this is a spatial join.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the current spatial join and merge APIs, then compare their behavior with pandas' traditional join semantics. The issue leaves the solution open between renaming methods and clarifying the existing API; done should mean users are not likely to mistake the spatial join for a full table join.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- pandas, python
- Domain
- data
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100