Skip to content

Commit fe451bb

Browse files
committed
remove old manual
link to readthedocs minor formatting changes
1 parent 6967a39 commit fe451bb

5 files changed

Lines changed: 13 additions & 9 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1-
# NLA Toolbox
1+
# Network Level Analysis (NLA) Toolbox
22

3-
See included manual for reference information.
3+
NLA is an extensible MATLAB-based software package for the analysis of behavioral associations with brain connectivity data.
4+
5+
Documentation is located at [read the docs](https://network-level-analysis-toolbox.readthedocs.io/en/latest)

docs/source/for_developers.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ Creating additional edge-level tests
88

99
Current tests are located in ``+nla/+edge/+test``. This is where all the current tests are located and also where
1010
any user-created custom tests will need to be saved. All edge-level test objects must inherit from ``nla.edge.BaseTest``
11+
12+
* **Test object**
13+
1114
..
1215
commenting this out because it's broken right now. filed report on github
1316
.. mat:module:: edge
@@ -25,11 +28,11 @@ any user-created custom tests will need to be saved. All edge-level test objects
2528
may be used and this step can be skipped. If a new result is needed, a permutation result inheriting ``+nla/+edge/+result/PermBase``
2629
must also be created
2730

28-
.. mat:module:: edge.result
31+
.. mat:module:: edge.result
2932
30-
.. mat:autoclass:: Base
33+
.. mat:autoclass:: Base
3134
32-
.. mat:automethod:: output(net_atlas, flags, prob_label)
35+
.. mat:automethod:: output(net_atlas, flags, prob_label)
3336
3437
Creating additional network-level tests
3538
----------------------------------------------------------

docs/source/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ Welcome to NetworkLevelAnalysis's documentation!
2121
network_level_tests
2222
network_level_results
2323
for_developers
24-
bibliography
2524

2625

2726
Indices and tables

docs/source/methodology.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ The Network Level Analysis (NLA) Method
66

77
First, connectome-wide associations are calculated between ROI-pair connectivity and behavioral data,
88
resulting in a set of standardized regression coefficients that specify the brain-behavior association at
9-
each ROI-pair of the connectome matrix. Next, network level analysis-consisting of transformation of the
10-
edge-level test statistics and enrichment statistic calculation :cite:p:`AckermanM` - is done to determine which networks are
9+
each ROI-pair of the connectome matrix. Next, network level analysis, consisting of a transformation of the
10+
edge-level test statistics and enrichment statistic calculation :cite:p:`AckermanM`, is done to determine which networks are
1111
strongly associated with the behavior of interest.
1212

1313
Both *p*-value and test-statistic binarization are offered in the current NLA pipeline :cite:p:`EggebrechtA,WheelockM:2018`. Prior research has
@@ -22,7 +22,7 @@ applications :cite:p:`ChenJ,NewtonM,YaariG,EfronB`.
2222
Permutation testing
2323
""""""""""""""""""""""""""""""""""""""""""""""""""
2424

25-
Permutation testing can be used to provide approximate control of false positives and allow use of different statistics.
25+
Permutation testing can be used to provide approximate control of false positive results and allow wide variety of test statistics.
2626
This is done under the assumption that the data are exchangeable under the null hypothesis - the joint distribution of the
2727
error terms don't change with the permutation.
2828

manual.pdf

-1.73 MB
Binary file not shown.

0 commit comments

Comments
 (0)