Skip to content

Commit 74587cd

Browse files
committed
update README
1 parent 1e305de commit 74587cd

File tree

1 file changed

+9
-28
lines changed

1 file changed

+9
-28
lines changed

README.md

Lines changed: 9 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,5 @@
11
# CPP ROI
22

3-
---
4-
5-
## :warning:
6-
7-
**This code is fairly unstable and might still change.**
8-
9-
So make sure you "pin" which version or commit you are using for a given
10-
project, if you don't want your code to break in the future.
11-
12-
---
13-
143
Set of Octave and Matlab functions, demos and scripts to help manage ROIs and to
154
play nice with BIDS datasets.
165

@@ -33,41 +22,33 @@ git clone https://github.com/cpp-lln-lab/CPP_ROI.git
3322
Fire up Octave or Matlab and type
3423

3524
```matlab
36-
3725
cd CPP_ROI
3826
3927
% Th following adds the relevant folders to your path.
4028
% This needs to be done once per session (your path will not be saved)
4129
4230
initCppRoi
43-
4431
```
4532

4633
If you are using CPP_SPM, you got nothing to do as CPP_ROI is already installed
4734
as a submodule, and intitialized when running `initCppSpm`.
4835

4936
### Dependencies
5037

51-
======= TODO
52-
53-
| Dependencies | Used version |
54-
| ---------------------------------------------------------- | ------------ |
55-
| [Matlab](https://www.mathworks.com/products/matlab.html) | 20??? |
56-
| or [octave](https://www.gnu.org/software/octave/) | 4.? |
57-
| [SPM12](https://www.fil.ion.ucl.ac.uk/spm/software/spm12/) | v7487 |
58-
59-
- bids-matlab (INSERT URL)
60-
61-
- currently still needs some CPP_SPM function but ultimately should be
62-
standalone: this will most likely happen when some functions are passed to
63-
bids-matlab
38+
| Dependencies | Used version |
39+
| --------------------------------------------------------------- | ------------ |
40+
| [Matlab](https://www.mathworks.com/products/matlab.html) | 20??? |
41+
| or [octave](https://www.gnu.org/software/octave/) | 4.? |
42+
| [SPM12](https://www.fil.ion.ucl.ac.uk/spm/software/spm12/) | v7487 |
43+
| [bids-matlab](https://github.com/bids-standard/bids-matlab.git) | >=0.1.0 |
6444

6545
- Other dependencies (MarsBar) are shipped with CPP_ROI in the `lib` folder.
6646

6747
## Features
6848

6949
- create ROI from probability maps
70-
- create ROI filenames that "BIDS-ish"
50+
- create ROI from atlas (see below)
51+
- create ROI filenames that are "BIDS-ish"
7152
- extract ROI with a given numerical label
7253
- extract ROI from one hemisphere
7354
- breaks a cluster image into several ROIs with each their own label
@@ -88,4 +69,4 @@ as a submodule, and intitialized when running `initCppSpm`.
8869
Also includes:
8970

9071
- Yeo's 7 networks "atlas"
91-
<!-- add REF and URL -->
72+
<!-- add REF and URL -->

0 commit comments

Comments
 (0)