Skip to content

Commit 7596ef1

Browse files
committed
Updated the user documentation
1 parent 2e3183e commit 7596ef1

1 file changed

Lines changed: 62 additions & 0 deletions

File tree

docs/user_guide.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,9 @@ HEDTools provides a unified command-line interface (CLI) using a **git-style com
283283
| ----------------------------- | ----------------------------------------------------------- |
284284
| **Annotation management** | |
285285
| `hedpy validate bids-dataset` | Validate HED annotations in BIDS datasets |
286+
| `hedpy validate string` | Validate HED annotations in a string |
287+
| `hedpy validate sidecar` | Validate HED annotations in a JSON sidecar |
288+
| `hedpy validate tabular` | Validate HED annotations in a tabular file (TSV) |
286289
| `hedpy extract bids-sidecar` | Extract JSON sidecar template from tabular (`.tsv`) files |
287290
| **Schema management** | |
288291
| `hedpy schema validate` | Validate HED schema files |
@@ -403,6 +406,62 @@ hedpy validate bids-dataset /path/to/bids/dataset \
403406

404407
______________________________________________________________________
405408

409+
### String validation
410+
411+
Validate a HED string using `hedpy validate string`.
412+
413+
```bash
414+
# Basic validation
415+
hedpy validate string "Event, Action" -sv 8.3.0
416+
417+
# With definitions
418+
hedpy validate string "Event, Def/MyDef" \
419+
-sv 8.4.0 \
420+
-d "(Definition/MyDef, (Action, Move))"
421+
422+
# Check for warnings
423+
hedpy validate string "Event, Action/Button-press" -sv 8.4.0 -w
424+
```
425+
426+
______________________________________________________________________
427+
428+
### Sidecar validation
429+
430+
Validate a HED JSON sidecar using `hedpy validate sidecar`.
431+
432+
```bash
433+
# Basic validation
434+
hedpy validate sidecar task-rest_events.json -sv 8.3.0
435+
436+
# With multiple schemas
437+
hedpy validate sidecar task-rest_events.json -sv 8.3.0 -sv score_1.1.0
438+
439+
# Check for warnings and save to file
440+
hedpy validate sidecar task-rest_events.json -sv 8.4.0 -w -o results.txt
441+
```
442+
443+
______________________________________________________________________
444+
445+
### Tabular validation
446+
447+
Validate a HED tabular file (TSV) using `hedpy validate tabular`.
448+
449+
```bash
450+
# Basic validation
451+
hedpy validate tabular events.tsv -sv 8.3.0
452+
453+
# With a sidecar
454+
hedpy validate tabular events.tsv -s sidecar.json -sv 8.3.0
455+
456+
# Limit errors
457+
hedpy validate tabular events.tsv -sv 8.3.0 -el 5
458+
459+
# Check for warnings and output JSON
460+
hedpy validate tabular events.tsv -sv 8.3.0 -w -f json -o results.json
461+
```
462+
463+
______________________________________________________________________
464+
406465
### Sidecar template extraction
407466

408467
Extract a JSON sidecar template from BIDS event files using `hedpy extract bids-sidecar`.
@@ -534,6 +593,9 @@ For backward compatibility, you can still access scripts directly using Python m
534593
```bash
535594
# Validation
536595
python -m hed.scripts.validate_bids /path/to/dataset --check-warnings
596+
python -m hed.scripts.validate_hed_string "Event, Action" -sv 8.3.0
597+
python -m hed.scripts.validate_hed_sidecar sidecar.json -sv 8.3.0
598+
python -m hed.scripts.validate_hed_tabular events.tsv -sv 8.3.0
537599

538600
# Sidecar extraction
539601
python -m hed.scripts.hed_extract_bids_sidecar /path/to/dataset -s events

0 commit comments

Comments
 (0)