Skip to content

Commit

Permalink
[DOC] add CLI info for group level (#128)
Browse files Browse the repository at this point in the history
* verbose in ci

* update README and add group image
  • Loading branch information
Remi-Gau authored Jan 23, 2023
1 parent dc5c8d0 commit 47678d7
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ jobs:
mkdir -p ${HOME}/data/
datalad install -s ///openneuro/ds002799 ${HOME}/data/ds002799
cd ${HOME}/data/ds002799/derivatives/fmriprep
datalad get sub-30[27]/ses-*/func/*run-*MNI152NLin2009cAsym*preproc*bold*
datalad get -J 2 sub-30[27]/ses-*/func/*run-*MNI152NLin2009cAsym*preproc*bold*
datalad unlock sub-30[27]/ses-*/func/*run-*MNI152NLin2009cAsym*preproc*bold*
- save_cache:
key: my_cache
Expand Down
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,17 @@ This can be used also for other multivariate pattern
analyses in the absence of eye-tracking data.
Decoded gaze positions allow computing eye movements.

Some basic quality control and outliers detection is also performed.
Some basic quality control and outliers detection is also performed:

- for each run

![](https://github.com/cpp-lln-lab/bidsMReye/blob/main/docs/source/images/sub-01_task-auditory_space-MNI152NLin6Asym_desc-bidsmreye_eyetrack.png)


- at the group level

![](https://github.com/cpp-lln-lab/bidsMReye/blob/main/docs/source/images/group_eyetrack.png)

For more information, see the
[User Recommendations](https://deepmreye.slite.com/p/channel/MUgmvViEbaATSrqt3susLZ/notes/kKdOXmLqe).
If you have other questions, please reach out to the developer team.
Expand All @@ -56,7 +63,7 @@ of deepmreye on Apple M1 for example.
docker build --tag cpplab/bidsmreye:latest --file docker/Dockerfile .
```

#### Pull (work in progress)
#### Pull

Pull the latest docker image:

Expand Down Expand Up @@ -157,7 +164,8 @@ If your data is not in MNI space, bidsmreye will also register the data to MNI.
```bash
bidsmreye --action prepare \
bids_dir \
output_dir
output_dir \
participant
```

## Computing the eye movements
Expand All @@ -170,7 +178,8 @@ This will also generate a quality control report of the decoded eye movements.
```bash
bidsmreye --action generalize \
bids_dir \
output_dir
output_dir \
participant
```
## Doing it all at once

Expand All @@ -179,9 +188,17 @@ bidsmreye --action generalize \
```bash
bidsmreye --action all \
bids_dir \
output_dir
output_dir \
participant
```

## Group level summary

bidsmreye --action qc \
bids_dir \
output_dir \
group

## Demo

Please look up the [documentation](https://bidsmreye.readthedocs.io/en/latest/demo.html)
Expand Down
Binary file added docs/source/images/group_eyetrack.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 47678d7

Please sign in to comment.