fmriu.io.collection.open_graphs: Open Graphs Collection

Description Usage Arguments Value

Description

A utility to open graphs information from multiple datasets. Assumes data is formatted by the BIDs spec. This means that derivatives are named as follows: sub-[###]_task-[abcde]_ses-[###]_run-[###]_(generic info).file

Usage

1
2
3
fmriu.io.collection.open_graphs(basepath, datasets = "", atlases = "",
  gname = "connectomes", fmt = "graphml", verbose = FALSE,
  rtype = "list", flatten = FALSE)

Arguments

basepath:

[1] a path to a properly spec'd directory. See the example in 'fmriutils.html' for details.

datasets:

[d] the datasets as a vector. Note that we expect a folder '<basepath>/<dataset>' for 'dataset in datasets'.

atlases:

[a] the atlases as a vector. Note that we expect a folder '<basepath>/<dataset>/<gname>/<atlas>' for 'atlas in atlases'.

gname='connectomes':

the folder name in which graphs are stored. Suggested options are ['connectomes', 'graphs'].

fmt="graphml"

a parameter indicating the format for graphs to be read in as. Options are ['graphml', 'edgelist'].

verbose=FALSE:

whether to print the id of the scan being loaded.

rtype='list':

the type of output to return. Options are 'list' and 'array'. Note that if rtype is 'array', all of the graphs must be derived from parcellations with the same number of vertices.

flatten=FALSE

a parameter to flatten the array if the rtype is set to 'array'.

TRUE

If rtype == 'array', then returns an [n x r^2] array

FALSE

If rtype == 'array', then returns an [n x r x r] array

Value

graphs: [[n]][nroi, nroi] the graphs loaded from the specified directory. Shape depends on the parameters specified.

dataset: [n] a vector of the dataset ids for each subject.

atlas: [n] a vector of the atlas ids for each subject.

subjects: [n] the subject ids

sessions: [n] the session ids

tasks: [n] the task ids

runs: [n] the run ids


neurodata/fmriutils documentation built on May 14, 2019, 2:30 p.m.