Skip to content

Commit dd569b6

Browse files
authored
Update usage.md
1 parent d574931 commit dd569b6

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/usage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ conda activate <ENV_NAME>
2222

2323
### **Step 3: Data Organization**
2424

25-
The package requires the recorded XDF data to be organized in a specific directory structure which is semi-compliant with the BIDS (Brain Imaging Data Structure) format. The BIDS format is a standard for organizing and describing neuroimaging data, making it easier to share and analyze.
25+
The package requires the recorded XDF data to be organized in a specific directory structure following the BIDS (Brain Imaging Data Structure) naming convention. This is the default output of the popular [labrecorder](https://github.com/labstreaminglayer/App-LabRecorder). The BIDS format is a standard for organizing and describing neuroimaging data, making it easier to share and analyze.
2626

2727

2828
- The `projects` root location is the root directory where all the eeg raw recordings (say `.xdf` files) are stored e.g. `projects/sub-A/ses-001/eeg/sub-A_ses-001_task-foo.xdf`.
2929
- The (optional) `project_other` root location is the directory where the experiments (e.g `.py`, `.oxexp`) and behavioral files (e.g. eye-tracking recordings, labnotebook, participant forms, etc ) are stored.
3030
- The `bids` root location is the directory where the converted BIDS data is stored, along with source data and code files which we want to version control using `Datalad`.
3131

3232
!!! IMPORTANT
33-
Please follow the BIDS data organization guidelines for storing the neuroimaging data for running this package. The BIDS conversion guidelines are based on the recommended directory/files structure. You only can change the location of the root directories according to your preference. You must also strictly follow the naming convention for the project and subject subdirectories.
33+
The package is looking in these paths, and extracts some metadata from the BIDS-like names. You can change the location of the root directories according to your preference. You must also strictly follow the naming convention for the project and subject subdirectories.
3434

3535
Here you will find the recommended directory structure for storing the project data (recorded, other and converted data) in the [data_organization](docs/data_organization.md) file.
3636

@@ -62,4 +62,4 @@ Run the conversion scripts to convert the xdf files to BIDS format and upload th
6262
lslautobids run -p TestData2025
6363
```
6464
!!! NOTE
65-
You can run the `--help` for all the commands to get more information about the available options and directly `lsl-autobids help` to get the list of available commands.
65+
You can run the `--help` for all the commands to get more information about the available options and directly `lsl-autobids help` to get the list of available commands.

0 commit comments

Comments
 (0)