Skip to content

Commit 76a942f

Browse files
authored
Update collate_participant_tables() docstring
1 parent b97ff60 commit 76a942f

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

mindboggle/mio/tables.py

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1150,10 +1150,22 @@ def collate_participant_tables(subject_ids, base_dir):
11501150
base_dir: str
11511151
path to a mindboggle output base directory (mindboggled)
11521152
1153+
Returns
1154+
-------
1155+
collated_table : pandas DataFrame
1156+
rows of subject_ids, and columns of shape measures
11531157
1158+
Examples
1159+
--------
11541160
>>> from mindboggle.mio.tables import collate_participant_tables
1155-
>>> dft = collate_participant_tables(['sub-1', 'sub-2'],
1156-
... '/path/to/mindboggled/') # doctest: +SKIP
1161+
>>> subject_ids = ['arno', 'arno'] # normally two different subjects
1162+
>>> base_dir = os.environ['MINDBOGGLE_DATA'] # doctest: +SKIP
1163+
>>> dft = collate_participant_tables(subject_ids, base_dir) # doctest: +SKIP
1164+
>>> dft['lcsfs-sylvian fissure-area'] # doctest: +SKIP
1165+
arno 4.641015
1166+
arno 4.641015
1167+
Name: lcsfs-sylvian fissure-area, dtype: float64
1168+
11571169
"""
11581170
from glob import glob
11591171
import os

0 commit comments

Comments
 (0)