You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .specify/specs/00-initial-design.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,12 +28,13 @@ A researcher has a BIDS file with an incorrect entity or a non-compliant name (e
28
28
3.**Given** a file with an associated `_scans.tsv` entry, **When** the file is renamed, **Then** the corresponding row in `_scans.tsv` is updated to reflect the new filename.
29
29
4.**Given** a file that is referenced nowhere else, **When** renamed, **Then** only the file and its sidecars are affected — no unrelated files change.
30
30
5.**Given** a rename that would produce a filename conflicting with an existing file, **When** the user runs the command, **Then** the tool refuses with exit code 2 and a clear error message.
31
+
6.**Given** a file which is not valid BIDS, e.g. ends with `_bold__dup-01.json`, tool operates correctly regardless that original file name is not valid BIDS.
31
32
32
33
---
33
34
34
35
### User Story 2 — Migrate a dataset toward BIDS 2.0 (Priority: P1, need: high)
35
36
36
-
A lab maintaining a BIDS 1.x dataset needs to address deprecations and prepare for BIDS 2.0. They run `bids-utils migrate` which reads the machine-readable schema (via `bidsschematools`) and applies the necessary transformations (entity renames, metadata key changes, structural reorganization) in a safe, reversible manner.
37
+
A lab maintaining a BIDS 1.x dataset needs to address deprecations and prepare for BIDS 2.0. They run `bids-utils migrate --to 2.0` which reads the machine-readable schema (via `bidsschematools`) and applies the necessary transformations (entity renames, metadata key changes, structural reorganization) in a safe manner. Changes do not need to be reversible - use of VCS should incouraged instead to retain prior versions.
37
38
38
39
**Why this priority**: BIDS 2.0 is approaching and many datasets need a migration path. A prototype already exists (bids-specification PR #2282) validating the concept.
39
40
@@ -50,7 +51,7 @@ A lab maintaining a BIDS 1.x dataset needs to address deprecations and prepare f
50
51
51
52
### User Story 3 — Rename a subject (Priority: P2, need: medium)
52
53
53
-
A data manager needs to anonymize or re-number a subject. They run `bids-utils subject-rename sub-01 sub-99`. The tool renames the `sub-` directory, every file within it (since all carry the `sub-` prefix), updates `participants.tsv`, updates all `_scans.tsv` files, and optionally processes `sourcedata/` and `.heudiconv/`.
54
+
A data manager needs to anonymize or re-number a subject. They run `bids-utils subject-rename sub-01 sub-99`. The tool renames the `sub-` directory, every file within it (since all carry the `sub-` prefix), updates `participants.tsv`, updates all `_scans.tsv` files, and optionally processes `sourcedata/`, `.heudiconv/` and common derivatives under `derivatives/` (via recursive calls to the same method on each derivative).
54
55
55
56
**Why this priority**: Common real-world need. Composes on top of the P1 `rename` primitive. Medium priority per design doc.
0 commit comments