Skip to content

Commit fecc6ec

Browse files
committed
update the notebook to include more documentation
1 parent 89a237a commit fecc6ec

File tree

1 file changed

+49
-7
lines changed

1 file changed

+49
-7
lines changed

run_and_explore.ipynb

Lines changed: 49 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,27 @@
11
{
22
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"id": "69c306a1-f24a-410a-b034-f002bc0b7a97",
6+
"metadata": {},
7+
"source": [
8+
"# Neurosynth Compose Notebook\n",
9+
"\n",
10+
"After you've built your meta-analysis on neurosynth compose, you can use this notebook to execute and view the meta-analytic results.\n",
11+
"All you need is to "
12+
]
13+
},
314
{
415
"cell_type": "code",
5-
"execution_count": null,
16+
"execution_count": 1,
617
"id": "28d0e8b6-9bbd-4256-a19a-ff36eeca5cfd",
718
"metadata": {},
819
"outputs": [],
920
"source": [
21+
"#@title 1) Run once to install NiMARE (~1 minute)\n",
22+
"%%capture --no-display --no-stderr\n",
1023
"%%bash\n",
24+
"wget https://raw.githubusercontent.com/neurostuff/neurosynth-compose-notebook/main/requirements.txt\n",
1125
"pip install -r requirements.txt"
1226
]
1327
},
@@ -16,7 +30,9 @@
1630
"id": "37860b1b-5031-4bd7-8e86-c668f545126b",
1731
"metadata": {},
1832
"source": [
19-
"## INSERT YOUR META-ANALYSIS ID HERE"
33+
"## INSERT YOUR META-ANALYSIS ID HERE\n",
34+
"\n",
35+
"This is the id for your specific meta-analysis"
2036
]
2137
},
2238
{
@@ -26,7 +42,20 @@
2642
"metadata": {},
2743
"outputs": [],
2844
"source": [
29-
"META_ID = \"3SD2A7LGuQTm\""
45+
"#@title 2) Set your Neurosynth-Compose Meta-Analysis ID { run: \"auto\" }\n",
46+
"\n",
47+
"META_ID = None # for example: \"8dJ6tG7wfbyS\""
48+
]
49+
},
50+
{
51+
"cell_type": "markdown",
52+
"id": "7dccf070-a1cc-4471-97f1-d386374a80df",
53+
"metadata": {},
54+
"source": [
55+
"## Run your selected Meta-Analysis\n",
56+
"\n",
57+
"A workflow in NiMARE will interpret the meta-analysis you specified and\n",
58+
"run the selected algorithm and corrector (optional) on the studyset selected."
3059
]
3160
},
3261
{
@@ -36,8 +65,7 @@
3665
"metadata": {},
3766
"outputs": [],
3867
"source": [
39-
"from nimare.workflows import compose_run\n",
40-
"from nilearn.plotting import plot_stat_map"
68+
"from nimare.workflows import compose_run # special workflow to run meta-analysis"
4169
]
4270
},
4371
{
@@ -61,7 +89,19 @@
6189
},
6290
"source": [
6391
"## Choose which statistical map to investigate\n",
64-
"default is z map, but each estimator/corrector combination may generate corrected/more appropriate statistical maps for summary/investigation"
92+
"\n",
93+
"The Default is the z map, but each estimator/corrector combination may generate\n",
94+
"corrected/more appropriate statistical maps for investigation."
95+
]
96+
},
97+
{
98+
"cell_type": "code",
99+
"execution_count": null,
100+
"id": "347e806d-a264-416e-8d52-8f9574bd3a58",
101+
"metadata": {},
102+
"outputs": [],
103+
"source": [
104+
"from nilearn.plotting import plot_stat_map # display statistical images"
65105
]
66106
},
67107
{
@@ -101,7 +141,9 @@
101141
"id": "b43d40b3-9c1d-490c-a3a2-173e04755932",
102142
"metadata": {},
103143
"source": [
104-
"## Investigate what studies contributed to which clusters"
144+
"## Investigate what studies contributed to which clusters\n",
145+
"\n",
146+
"Dive into your results to discover which analyses are driving your results."
105147
]
106148
},
107149
{

0 commit comments

Comments
 (0)