Skip to content

Commit dd428ae

Browse files
author
Andy
committed
Restore developer notes inadvertently dropped from last merge
1 parent bc5aef3 commit dd428ae

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

docs/source/for_developers.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,18 @@ will need to be saved. All edge-level test objects must inherit from ``nla.edge.
1111

1212
* **Test object**
1313

14-
..
15-
commenting this out because it's broken right now. filed report on github
16-
.. mat:module:: edge
14+
* Constant properties to define for the concrete class you're adding:
15+
* name - name of test (string / char, ex: "Pearson's r")
16+
* coeff_name - name of test statistic (string / char, ex: "Pearson's r (Fisher-Z Transformed)"
1717

18-
.. mat:autoclass:: BaseTest
18+
* a ``run`` method
19+
20+
.. mat:automethod:: result = run(obj, input_struct)
21+
input_struct typically contains the following fields in the normal GUI pipeline for most current tests (except SwE and OLS):
22+
* behavior - [numSubjects x 1] array of doubles
23+
* func_conn - nla.TriMatrix object, containing functional connectivity data for all edges and subjects
1924

20-
.. mat:automethod:: run(input_struct)
2125

22-
.. mat:automethod:: inputs = requiredInputs()
2326

2427

2528
* **Result object**
@@ -72,4 +75,4 @@ The only requirements are below
7275
:permutations: Boolean to determine if the test is being run with permutations (``true``) or without (``false``)
7376
:result: :doc:`NetworkTestResult </network_level_results>`
7477

75-
* ``requiredInputs`` See :ref:`Edge-level tests <requiredInputs>`
78+
* ``requiredInputs`` was an old field for dispalying input fields for the tests on the main NLA_GUI. For now, just define ``requiredInputs()`` as a static method of the class and have it return an empty cell array.

0 commit comments

Comments
 (0)