Skip to content

Commit a6896ea

Browse files
committed
Add Specification page
1 parent b4a622e commit a6896ea

File tree

4 files changed

+58
-2
lines changed

4 files changed

+58
-2
lines changed

docs/guide/Project/Specification.md

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,62 @@ title: Specification
33
sidebar_position: 2
44
---
55

6-
## Work in progress!
6+
# Meta-Analysis Specification
77

8-
We're still working on completing the documentation for this. Please check back later.
8+
Now that your studyset's studies have all the necessary information (metadata, coordinates, annotations), you can configure and run a meta-analysis!
9+
10+
A wizard will guide you through the following key steps of meta-analysis specification.
11+
12+
13+
14+
15+
### 1) **Select the Algorithm and Corrector**
16+
*Choose the algorithm for your meta-analysis and, optionally, select a statistical correction method (corrector).*
17+
18+
Neurosynth-Compose supports several meta-analysis algorithms, powered by NiMARE, a Python library for neuroimaging meta-analysis.
19+
For an overview to the coordinate-based meta-analysis methods supported by NiMARE, [refer to this guide](https://nimare.readthedocs.io/en/stable/cbma.html).
20+
21+
Supported coordinate-based methods include:
22+
23+
- **MKDADensity** (default): Multi-Kernel Density Analysis. A popular density-based meta-analysis algorithm. Creates a binary sphere around each coordinate.
24+
- **ALE**: Activation Likelihood Estimation, convolves coordinates with a 3D Gaussian distribution.
25+
- **MKDAChi2**: Allows you to compare your meta-analysis studies with a larger reference set of studies. It tests whether a higher proportion of studies in your meta-analysis activate a specific voxel compared to a larger population of studies that were not included. For more details, [**see the MKDAChi2 Association tutorial**](/compose-docs/tutorial/advanced/mkda_association)
26+
27+
For each algorithm, a default set of arguments is used, but you can easily modify them. For a complete reference on available arguments, see the [NiMARE API Docs](https://nimare.readthedocs.io/en/latest/api.html#nimare-meta-meta-analytic-algorithms).
28+
29+
Next, select a method for [multiple comparisons correction](https://nimare.readthedocs.io/en/latest/cbma.html#multiple-comparisons-correction):
30+
31+
32+
- **FDRCorrector** (default): False Discovery Rate correction.
33+
- **FWECorrector**: Family-Wise Error Rate correction. We strongly recommend using FWECorrector for publication-quality results with 10,000 iteration if possible. This is computationl intesive, however, hence not the default option.
34+
35+
![Wizard 1](/guide/specification_wizard1.png)
36+
37+
38+
### 2) **Select Analyses**
39+
Now you will select which studies & analyses you want to include in your meta-analysis. To do so, select the annotation column for inclusion, which determines which analyses are used in the meta-analysis. B
40+
y default, the "included" column contains all studies and analyses, but you can modify this based on your needs by editing `Annotations` in the Extraction step.
41+
42+
A preview of the included studies based on the selected annotation column will be displayed.
43+
44+
![Wizard 2](/guide/specification_wizard2.png)
45+
46+
47+
### 3) **Meta-Analysis Details**
48+
Enter a name and description for your meta-analysis to help you find it later. A default name will be provided, but you can customize it as needed.
49+
50+
### 4) **Review**
51+
Finally, you can review your selected options before creating your specification.
52+
53+
![Wizard 3 Review](/guide/specification_wizard3.png)
54+
55+
### 5) **Finalize**
56+
To complete the specification process, click the "Create Meta-Analysis Specification" button.
57+
58+
---
59+
60+
## Running the Meta-Analysis
61+
62+
After clicking "Create Meta-Analysis Specification," you will be taken to a page displaying the status of your running analyses. Refer to the next section of the documentation for details on running and monitoring your meta-analysis.
63+
64+
---
52.2 KB
Loading
107 KB
Loading
61.5 KB
Loading

0 commit comments

Comments
 (0)