Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kabilar committed Dec 12, 2023
1 parent 2402f2c commit c384f88
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion bids-validator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@
[Conda package](https://anaconda.org/conda-forge/bids-validator).
1. Open a Python terminal and type: `python`
1. Import the BIDS Validator package `from bids_validator import BIDSValidator`
1. Check if a file is BIDS compatible `BIDSValidator().is_bids('path/to/a/bids/file')`
1. Check if a file is BIDS compatible `BIDSValidator().is_bids('/relative/path/to/a/bids/file')`
1. Note, the file path must be relative to the root of the BIDS dataset, and
a leading forward slash `/` must be added to the file path.

## Support

Expand Down Expand Up @@ -405,6 +407,9 @@ for filepath in filepaths:
print(validator.is_bids(filepath)) # will print True, and then False
```

Note, the file path must be relative to the root of the BIDS dataset, and a
leading forward slash `/` must be added to the file path.

## Development

To develop locally, clone the project and run `npm install` from the project
Expand Down

0 comments on commit c384f88

Please sign in to comment.