fmriu.io.collection.open_timeseries: Open Timeseries Collection

Description Usage Arguments Value

Description

A utility to open timeseries 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
fmriu.io.collection.open_timeseries(basepath, datasets = "", atlases = "",
  verbose = FALSE, rtype = "list")

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>/timeseries/roi/<atlas>' for '<atlas> in <atlases>'.

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'.

Value

ts: [[n]][nt, nroi] the ts loaded from the specified directory. list of n subjects, each with nt timesteps and nroi rois

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.