|
a/README.md |
|
b/README.md |
1 |
# Spine Generic Public Database (Multi-Subject) |
1 |
# Spine Generic Public Database (Multi-Subject)
|
2 |
[](https://doi.org/10.5281/zenodo.4299140) |
2 |
[](https://doi.org/10.5281/zenodo.4299140)
|
3 |
[](https://github.com/spine-generic/data-multi-subject/actions?query=workflow%3A%22Dataset+Validator%22) |
3 |
[](https://github.com/spine-generic/data-multi-subject/actions?query=workflow%3A%22Dataset+Validator%22?raw=true) |
4 |
|
4 |
|
5 |
## About this dataset |
5 |
## About this dataset |
6 |
|
6 |
|
7 |
This dataset was acquired using the [spine-generic protocol](http://spinalcordmri.org/protocols) |
7 |
This dataset was acquired using the [spine-generic protocol](http://spinalcordmri.org/protocols)
|
8 |
on multiple subjects, multiple sites and multiple MRI vendors and models. The list of subjects |
8 |
on multiple subjects, multiple sites and multiple MRI vendors and models. The list of subjects
|
9 |
is available in [participants.tsv](./participants.tsv). |
9 |
is available in [participants.tsv](./participants.tsv). |
10 |
|
10 |
|
11 |
This dataset follows the [BIDS](https://bids.neuroimaging.io/) convention. |
11 |
This dataset follows the [BIDS](https://bids.neuroimaging.io/) convention.
|
12 |
The contributors have the necessary ethics & permissions to share the data publicly. |
12 |
The contributors have the necessary ethics & permissions to share the data publicly. |
13 |
|
13 |
|
14 |
The dataset does not include any identifiable personal health information, including names, |
14 |
The dataset does not include any identifiable personal health information, including names,
|
15 |
zip codes, dates of birth, facial features on structural scans. |
15 |
zip codes, dates of birth, facial features on structural scans. |
16 |
|
16 |
|
17 |
The entire dataset is about **26GB**. |
17 |
The entire dataset is about **26GB**. |
18 |
|
18 |
|
19 |
## Download |
19 |
## Download |
20 |
|
20 |
|
21 |
We are using a tool to manage large datasets called `git-annex`. To download this dataset, you need to have `git` installed, and also [install `git-annex`](https://github.com/neuropoly/data-management/blob/master/git-annex.md#installation) |
21 |
We are using a tool to manage large datasets called `git-annex`. To download this dataset, you need to have `git` installed, and also [install `git-annex`](https://github.com/neuropoly/data-management/blob/master/git-annex.md#installation) |
22 |
|
22 |
|
23 |
> ⚠️ Make sure you have at least **version 8** by running: |
23 |
> ⚠️ Make sure you have at least **version 8** by running:
|
24 |
> |
|
|
25 |
> ``` |
|
|
26 |
> git annex version | head -n 1 |
24 |
> git annex version | head -n 1
|
27 |
> # the answer should show something like: git-annex version: 8.20200330 |
25 |
> # the answer should show something like: git-annex version: 8.20200330 |
28 |
> ``` |
26 |
|
29 |
|
27 |
|
30 |
|
28 |
|
31 |
Then this will download the dataset: |
29 |
Then this will download the dataset: |
32 |
|
30 |
|
33 |
``` |
31 |
```
|
34 |
git clone https://github.com/spine-generic/data-multi-subject && \ |
32 |
git clone https://github.com/spine-generic/data-multi-subject && \
|
35 |
cd data-multi-subject && \ |
33 |
cd data-multi-subject && \
|
36 |
git annex init && \ |
34 |
git annex init && \
|
37 |
git annex get . |
35 |
git annex get .
|
38 |
``` |
36 |
``` |
39 |
|
37 |
|
40 |
You may **substitute** `git annex get` with more specific commands if you are only interested in certain subjects. For example: |
38 |
You may **substitute** `git annex get` with more specific commands if you are only interested in certain subjects. For example: |
41 |
|
39 |
|
42 |
``` |
40 |
```
|
43 |
git annex get sub-nwu01/ sub-nwu03/ sub-nwu04/ sub-oxfordFmrib04/ sub-tokyoSkyra*/ |
41 |
git annex get sub-nwu01/ sub-nwu03/ sub-nwu04/ sub-oxfordFmrib04/ sub-tokyoSkyra*/
|
44 |
``` |
42 |
``` |
45 |
|
43 |
|
46 |
If you with to update an already-cloned repository, run: |
44 |
If you with to update an already-cloned repository, run: |
47 |
|
45 |
|
48 |
``` |
46 |
```
|
49 |
git pull && git annex get . |
47 |
git pull && git annex get .
|
50 |
``` |
48 |
``` |
51 |
|
49 |
|
52 |
See more at [the official documentation](https://git-annex.branchable.com/walkthrough/) and take note of our [in-lab troubleshooting](https://github.com/neuropoly/data-management/blob/master/git-annex.md). |
50 |
See more at [the official documentation](https://git-annex.branchable.com/walkthrough/) and take note of our [in-lab troubleshooting](https://github.com/neuropoly/data-management/blob/master/git-annex.md). |
53 |
|
51 |
|
54 |
## Working from a forked repository |
52 |
## Working from a forked repository |
55 |
|
53 |
|
56 |
> ⚠️ For advanced users only. Normally the instructions under [Download](#Download) should be enough. |
54 |
###⚠️ For advanced users only. Normally the instructions under [Download](#Download) should be enough. |
57 |
|
55 |
|
58 |
If you have forked this repository on Github (so that you have a copy `your-user-name/data-multi-subject` of `spine-generic/data-multi-subject`), you will need to take a few extra synchronization steps to get the latest data with `git annex get`. Otherwise, you may get an error message like: |
56 |
If you have forked this repository on Github (so that you have a copy `your-user-name/data-multi-subject` of `spine-generic/data-multi-subject`), you will need to take a few extra synchronization steps to get the latest data with `git annex get`. Otherwise, you may get an error message like:
|
59 |
``` |
57 |
```
|
60 |
get some-file-name.nii.gz (not available) |
58 |
get some-file-name.nii.gz (not available)
|
61 |
No other repository is known to contain the file. |
59 |
No other repository is known to contain the file. |
62 |
|
60 |
|
63 |
(Note that these git remotes have annex-ignore set: origin) |
61 |
(Note that these git remotes have annex-ignore set: origin)
|
64 |
failed |
62 |
failed
|
65 |
``` |
63 |
``` |
66 |
|
64 |
|
67 |
1. In your local clone of `your-user-name/data-multi-subject`, make sure that `spine-generic/data-multi-subject` is also configured as a remote: |
65 |
1. In your local clone of `your-user-name/data-multi-subject`, make sure that `spine-generic/data-multi-subject` is also configured as a remote:
|
68 |
``` |
66 |
```
|
69 |
git remote -v |
67 |
git remote -v
|
70 |
# the answer should show both your-user-name/data-multi-subject.git (probably named "origin") |
68 |
# the answer should show both your-user-name/data-multi-subject.git (probably named "origin")
|
71 |
# and spine-generic/data-multi-subject (probably named "upstream") |
69 |
# and spine-generic/data-multi-subject (probably named "upstream")
|
72 |
``` |
70 |
``` |
73 |
|
71 |
|
74 |
If `spine-generic/data-multi-subject` is missing, you can add it with: |
72 |
If `spine-generic/data-multi-subject` is missing, you can add it with:
|
75 |
``` |
73 |
```
|
76 |
git remote add upstream https://github.com/spine-generic/data-multi-subject.git |
74 |
git remote add upstream https://github.com/spine-generic/data-multi-subject.git
|
77 |
git config remote.upstream.annex-readonly true |
75 |
git config remote.upstream.annex-readonly true
|
78 |
``` |
76 |
``` |
79 |
|
77 |
|
80 |
2. Then, to update your local clone, make sure to fetch the `git-annex` branch from `spine-generic/data-multi-subject` before running `git annex get`: |
78 |
2. Then, to update your local clone, make sure to fetch the `git-annex` branch from `spine-generic/data-multi-subject` before running `git annex get`:
|
81 |
``` |
79 |
```
|
82 |
git fetch upstream +refs/heads/git-annex:refs/remotes/upstream/git-annex |
80 |
git fetch upstream +refs/heads/git-annex:refs/remotes/upstream/git-annex
|
83 |
git pull && git annex get . |
81 |
git pull && git annex get .
|
84 |
``` |
82 |
``` |
85 |
|
83 |
|
86 |
## Analysis |
84 |
## Analysis |
87 |
|
85 |
|
88 |
The instructions to process this dataset are available in the [spine-generic documentation](https://spine-generic.readthedocs.io/en/latest/analysis-pipeline.html). |
86 |
The instructions to process this dataset are available in the [spine-generic documentation](https://spine-generic.readthedocs.io/en/latest/analysis-pipeline.html). |
89 |
|
87 |
|
90 |
## Help |
88 |
## Help |
91 |
|
89 |
|
92 |
If you have problems downloading the dataset, please post an [issue](https://github.com/spine-generic/data-multi-subject/issues). Document your steps as much as possible and copy/paste the content of your Terminal. |
90 |
If you have problems downloading the dataset, please post an [issue](https://github.com/spine-generic/data-multi-subject/issues). Document your steps as much as possible and copy/paste the content of your Terminal. |
93 |
|
91 |
|
94 |
## Contributing |
92 |
## Contributing |
95 |
|
93 |
|
96 |
If you wish to contribute to this dataset please see [the wiki](https://github.com/spine-generic/spine-generic/wiki/git-annex). Thank you for your contribution 🎉 |
94 |
If you wish to contribute to this dataset please see [the wiki](https://github.com/spine-generic/spine-generic/wiki/git-annex). Thank you for your contribution 🎉
|