Add a glossary page to the documentation (#706)

* Draft a glossary page with a couple of terms. * Update glossary.rst
neurostuff · Jun 14, 2022 · 035804c · 035804c
1 parent 519003f
commit 035804c
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 5 deletions.
diff --git a/docs/glossary.rst b/docs/glossary.rst
@@ -0,0 +1,16 @@
+.. include:: links.rst
+
+Glossary
+========
+
+.. glossary::
+
+    beta
+        The parameter estimate from a contrast analysis.
+        This is equivalent to cope images in FSL and con images in SPM.
+
+    varcope
+        The estimated variance of the parameter estimate.
+        This is also often referred to as "sampling variance".
+
+        We refer to this as "varcope" because that is the term used by FSL.
diff --git a/docs/index.rst b/docs/index.rst
@@ -130,6 +130,7 @@ Then, to cite NiMARE in your manuscript, we recommend something like the followi
    outputs
    methods
    changelog
+   glossary
 
 Indices and tables
 ------------------

diff --git a/nimare/meta/ibma.py b/nimare/meta/ibma.py
@@ -295,7 +295,7 @@ class WeightedLeastSquares(IBMAEstimator):
 
     Notes
     -----
-    Requires ``beta`` and ``varcope`` images.
+    Requires :term:`beta` and :term:`varcope` images.
 
     :meth:`fit` produces a :class:`~nimare.results.MetaResult` object with the following maps:
 
@@ -376,7 +376,7 @@ class DerSimonianLaird(IBMAEstimator):
 
     Notes
     -----
-    Requires ``beta`` and ``varcope`` images.
+    Requires :term:`beta` and :term:`varcope` images.
 
     :meth:`fit` produces a :class:`~nimare.results.MetaResult` object with the following maps:
 
@@ -454,7 +454,7 @@ class Hedges(IBMAEstimator):
 
     Notes
     -----
-    Requires ``beta`` and ``varcope`` images.
+    Requires :term:`beta` and :term:`varcope` images.
 
     :meth:`fit` produces a :class:`~nimare.results.MetaResult` object with the following maps:
 
@@ -541,7 +541,7 @@ class SampleSizeBasedLikelihood(IBMAEstimator):
 
     Notes
     -----
-    Requires ``beta`` images and sample size from metadata.
+    Requires :term:`beta` images and sample size from metadata.
 
     :meth:`fit` produces a :class:`~nimare.results.MetaResult` object with the following maps:
 
@@ -638,7 +638,7 @@ class VarianceBasedLikelihood(IBMAEstimator):
 
     Notes
     -----
-    Requires ``beta`` and ``varcope`` images.
+    Requires :term:`beta` and :term:`varcope` images.
 
     :meth:`fit` produces a :class:`~nimare.results.MetaResult` object with the following maps: