Skip to content

Commit fa8bb6e

Browse files
committed
doc: add additional kwargs, doctest
1 parent ea9e62a commit fa8bb6e

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

templateflow/api.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ def get(template, **kwargs):
2323
BIDS suffix
2424
atlas : str
2525
Name of a particular atlas
26+
hemi : str
27+
Hemisphere
28+
space : str
29+
Space template is mapped to
30+
density : str
31+
Surface density
2632
desc : str
2733
Description field
2834
@@ -39,6 +45,9 @@ def get(template, **kwargs):
3945
['.../tpl-MNI152Lin/tpl-MNI152Lin_res-01_T1w.nii.gz',
4046
'.../tpl-MNI152Lin/tpl-MNI152Lin_res-02_T1w.nii.gz']
4147
48+
>>> str(get('fsLR', space='fsaverage', suffix='sphere', hemi='L', density='32k')) +ELLIPSIS
49+
'.../tpl-fsLR_space-fsaverage_hemi-L_den-32k_sphere.surf.gii'
50+
4251
"""
4352
out_file = [Path(p) for p in TF_LAYOUT.get(
4453
template=template, return_type='file', **kwargs)]

templateflow/conf/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
},
2121
{
2222
"name": "density",
23-
"pattern": "[_/\\\\]+den-([a-zA-Z0-9]+)",
23+
"pattern": "[_/\\\\]+den-([a-zA-Z0-9]+)"
2424
},
2525
{
2626
"name": "atlas",

0 commit comments

Comments
 (0)