con / con/nwb2bids

Add more sanitization levels

Open
#180 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
5
Forks
6
Avg merge
4h 6m
Merged PRs (30d)
1

Description

Some more ideas for sanitization began in #75

Splitting into new issue since original has become basis for #167

### Level 1

Fix the session IDs and subject IDs according to the following rules:

- Any non-alphanumeric -> `+`

Also, write a new column to the requisite tables; `nwb_session_ids` and `nwb_subject_ids`, to record provenance and allow mapping to alleviate confusion.

No modification will be made in-place to the NWB contents.

Required for the majority of Dandisets.

If no possible changes are detected, act as if level 0 (even if level 1 is specified).

### Level 2

Same as level 1 as far as content, BUT edit all NWB file fields in-place accordingly so that they entirely match (are consistent with) the BIDS counterparts

### Level 3+

What other fields are worthy of sanitization?

Contributor guide

Open the contributing guide

Research direction

Start by reading the sanitization ideas in issue #75 and the work that became issue #167. Clarify the required Level 1 behavior for session and subject IDs, including the nwb_session_ids and nwb_subject_ids tables, then determine the scope of in-place Level 2 edits. Level 3+ remains open-ended, so completion criteria need to be agreed before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
bioinformatics, data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.