Skip to content

Commit

Permalink
[DOCS 📄] update rtd
Browse files Browse the repository at this point in the history
  • Loading branch information
saratheriver committed Nov 13, 2020
1 parent b9f165b commit 703e5a4
Show file tree
Hide file tree
Showing 15 changed files with 258 additions and 1 deletion.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/html/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions docs/pages/05.HCP/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ For details on HCP participants and data processing, please see our manuscript e
`Network-based atrophy modelling in the common epilepsies: a worldwide ENIGMA study <https://www.biorxiv.org/content/10.1101/2020.05.04.076836v1>`_!


.. admonition:: one matrix 🎤

Are you looking for subcortico-subcortical connectivity? Or do you want cortical and subcortical connectivity
in one 82 x 82 matrix (68 cortical + 14 subcortical regions)? If so, check out our functions: ``load_fc_as_one()``
:ref:`here<load_fc_as_one_mat>` and ``load_sc_as_one()`` :ref:`here<load_sc_as_one_mat>`!


.. _load_corticocortical:

Load cortical connectivity matrices
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
.. _apireferencelist_mat_load_fc_ws:

.. title:: Matlab API | load_fc_as_one

.. _load_fc_as_one_mat:

load_fc_as_one()
------------------------------

**Usage** [`source <https://github.com/MICA-MNI/ENIGMA/blob/master/matlab/scripts/load_connectivity/load_fc_as_one.m>`_]:
.. function::
[funcMatrix, funcLabels] = load_fc_as_one()

**Description:**
Load functional connectivity data (cortical + subcortical in one matrix) parcellated using Desikan Killiany (author: @saratheriver)

**Outputs:**
- **funcMatrix** (*double array*) – Functional connectivity, size = [82 x 82]
- **funcLabels** (*cell array*) – Region labels, size = [1 x 82]
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
.. _apireferencelist_mat_load_sc_ws:

.. title:: Matlab API | load_sc_as_one

.. _load_sc_as_one_mat:

load_sc_as_one()
------------------------------

**Usage** [`source <https://github.com/MICA-MNI/ENIGMA/blob/master/matlab/scripts/load_connectivity/load_sc_as_one.m>`_]:
.. function::
[strucMatrix, strucLabels] = load_sc_as_one()

**Description:**
Load structural connectivity data (cortical + subcortical in one matrix) parcellated using Desikan Killiany (author: @saratheriver)

**Outputs:**
- **strucMatrix** (*double array*) – Structural connectivity, size = [82 x 82]
- **strucLabels** (*cell array*) – Region labels, size = [1 x 82]
4 changes: 4 additions & 0 deletions docs/pages/13.02.apireferencematlab/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,12 @@ Matlab API

* - :ref:`load_fc()<load_fc_mat>`
- Load functional connectivity data parcellated using Desikan Killiany (author: @saratheriver)
* - :ref:`load_fc_as_one()<load_fc_as_one_mat>`
- Load functional connectivity data (cortical + subcortical in one matrix) parcellated using Desikan Killiany (author: @saratheriver)
* - :ref:`load_sc()<load_sc_mat>`
- Load structural connectivity data parcellated using Desikan Killiany (author: @saratheriver)
* - :ref:`load_sc_as_one()<load_sc_as_one_mat>`
- Load structural connectivity data (cortical + subcortical in one matrix) parcellated using Desikan Killiany (author: @saratheriver)


.. _matlabref_genedata:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
L,_,b,a,n,k,s,s,t,s,L,_,c,a,u,d,a,l,a,n,t,e,r,i,o,r,c,i,n,g,u,l,a,t,e,L,_,c,a,u,d,a,l,m,i,d,d,l,e,f,r,o,n,t,a,l,L,_,c,u,n,e,u,s,L,_,e,n,t,o,r,h,i,n,a,l,L,_,f,u,s,i,f,o,r,m,L,_,i,n,f,e,r,i,o,r,p,a,r,i,e,t,a,l,L,_,i,n,f,e,r,i,o,r,t,e,m,p,o,r,a,l,L,_,i,s,t,h,m,u,s,c,i,n,g,u,l,a,t,e,L,_,l,a,t,e,r,a,l,o,c,c,i,p,i,t,a,l,L,_,l,a,t,e,r,a,l,o,r,b,i,t,o,f,r,o,n,t,a,l,L,_,l,i,n,g,u,a,l,L,_,m,e,d,i,a,l,o,r,b,i,t,o,f,r,o,n,t,a,l,L,_,m,i,d,d,l,e,t,e,m,p,o,r,a,l,L,_,p,a,r,a,h,i,p,p,o,c,a,m,p,a,l,L,_,p,a,r,a,c,e,n,t,r,a,l,L,_,p,a,r,s,o,p,e,r,c,u,l,a,r,i,s,L,_,p,a,r,s,o,r,b,i,t,a,l,i,s,L,_,p,a,r,s,t,r,i,a,n,g,u,l,a,r,i,s,L,_,p,e,r,i,c,a,l,c,a,r,i,n,e,L,_,p,o,s,t,c,e,n,t,r,a,l,L,_,p,o,s,t,e,r,i,o,r,c,i,n,g,u,l,a,t,e,L,_,p,r,e,c,e,n,t,r,a,l,L,_,p,r,e,c,u,n,e,u,s,L,_,r,o,s,t,r,a,l,a,n,t,e,r,i,o,r,c,i,n,g,u,l,a,t,e,L,_,r,o,s,t,r,a,l,m,i,d,d,l,e,f,r,o,n,t,a,l,L,_,s,u,p,e,r,i,o,r,f,r,o,n,t,a,l,L,_,s,u,p,e,r,i,o,r,p,a,r,i,e,t,a,l,L,_,s,u,p,e,r,i,o,r,t,e,m,p,o,r,a,l,L,_,s,u,p,r,a,m,a,r,g,i,n,a,l,L,_,f,r,o,n,t,a,l,p,o,l,e,L,_,t,e,m,p,o,r,a,l,p,o,l,e,L,_,t,r,a,n,s,v,e,r,s,e,t,e,m,p,o,r,a,l,L,_,i,n,s,u,l,a,R,_,b,a,n,k,s,s,t,s,R,_,c,a,u,d,a,l,a,n,t,e,r,i,o,r,c,i,n,g,u,l,a,t,e,R,_,c,a,u,d,a,l,m,i,d,d,l,e,f,r,o,n,t,a,l,R,_,c,u,n,e,u,s,R,_,e,n,t,o,r,h,i,n,a,l,R,_,f,u,s,i,f,o,r,m,R,_,i,n,f,e,r,i,o,r,p,a,r,i,e,t,a,l,R,_,i,n,f,e,r,i,o,r,t,e,m,p,o,r,a,l,R,_,i,s,t,h,m,u,s,c,i,n,g,u,l,a,t,e,R,_,l,a,t,e,r,a,l,o,c,c,i,p,i,t,a,l,R,_,l,a,t,e,r,a,l,o,r,b,i,t,o,f,r,o,n,t,a,l,R,_,l,i,n,g,u,a,l,R,_,m,e,d,i,a,l,o,r,b,i,t,o,f,r,o,n,t,a,l,R,_,m,i,d,d,l,e,t,e,m,p,o,r,a,l,R,_,p,a,r,a,h,i,p,p,o,c,a,m,p,a,l,R,_,p,a,r,a,c,e,n,t,r,a,l,R,_,p,a,r,s,o,p,e,r,c,u,l,a,r,i,s,R,_,p,a,r,s,o,r,b,i,t,a,l,i,s,R,_,p,a,r,s,t,r,i,a,n,g,u,l,a,r,i,s,R,_,p,e,r,i,c,a,l,c,a,r,i,n,e,R,_,p,o,s,t,c,e,n,t,r,a,l,R,_,p,o,s,t,e,r,i,o,r,c,i,n,g,u,l,a,t,e,R,_,p,r,e,c,e,n,t,r,a,l,R,_,p,r,e,c,u,n,e,u,s,R,_,r,o,s,t,r,a,l,a,n,t,e,r,i,o,r,c,i,n,g,u,l,a,t,e,R,_,r,o,s,t,r,a,l,m,i,d,d,l,e,f,r,o,n,t,a,l,R,_,s,u,p,e,r,i,o,r,f,r,o,n,t,a,l,R,_,s,u,p,e,r,i,o,r,p,a,r,i,e,t,a,l,R,_,s,u,p,e,r,i,o,r,t,e,m,p,o,r,a,l,R,_,s,u,p,r,a,m,a,r,g,i,n,a,l,R,_,f,r,o,n,t,a,l,p,o,l,e,R,_,t,e,m,p,o,r,a,l,p,o,l,e,R,_,t,r,a,n,s,v,e,r,s,e,t,e,m,p,o,r,a,l,R,_,i,n,s,u,l,a,L,a,c,c,u,m,b,L,a,m,y,g,L,c,a,u,d,L,h,i,p,p,o,L,p,a,l,L,p,u,t,L,t,h,a,l,R,a,c,c,u,m,b,R,a,m,y,g,R,c,a,u,d,R,h,i,p,p,o,R,p,a,l,R,p,u,t,R,t,h,a,l
Loading

0 comments on commit 703e5a4

Please sign in to comment.