AllenInstitute / AllenInstitute/ConnectsCommonConnectivity
BrainRegionAssociation: no identity, unwritable as designed
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 4
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Problem: this class records which brain region a DataItem is in (region-to-region projection lives in ProjectionMeasurementMatrix), but has only two Optional fields — no id, no project_id. It can't be validated, scoped, or written. Blocks etl_wnm_exc_05.
Fix: add ProjectScoped; require brainregion_id/dataitem_id at write time via the io layer (required_for_write, per the convention in #14). Natural identity is (project_id, dataitem_id, brainregion_id) — no surrogate id needed once merge keys exist (#13).
Design note: a cell may get region assignments from multiple methods (CCF registration vs manual) or term sets — consider a method/source slot.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the BrainRegionAssociation definition and its io layer, then read the ProjectScoped convention in issue #14 and the merge-key discussion in issue #13. Done means the association is project-scoped, requires brainregion_id and dataitem_id when written, and has the stated natural identity without adding a surrogate id; the method/source design remains to be resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- data-engineering
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100