Autodoc test

neuropype

Parallel processing of MEG/EEG data

neuropype [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...

Options

-n, --ncpu <ncpu>

number of CPUs to use takes effect only for MultiProc and PBS plugins

-p, --plugin <plugin>

plugin to use; use Linear for single-thread computation, MultiProc parallel computation on local machine and PBS to compute on cluster

-s, --save-path <save_path>

path to store results

-w, --workflow-name <workflow_name>

name of destination directory

--verbose, --no-verbose

verbosity level

conn

Create spectral connectivity node

neuropype conn [OPTIONS]

Options

-b, --band <band>

frequency band

-m, --method <method>

connectivity measure

-s, --sfreq <sfreq>

data sampling frequency

ds2fif

Create ds2fif node.

Convert CTF .ds raw data to .fif format

neuropype ds2fif [OPTIONS]

ep2ts

Create a node for epochs 2 npy timeseries conversion

neuropype ep2ts [OPTIONS]

epoch

Epoch raw .fif resting state data

neuropype epoch [OPTIONS]

Options

-l, --length <length>

epoch length

ica

Compute ica solution for raw fif file

neuropype ica [OPTIONS]

Options

-n, --n-components <n_components>
-c, --ecg-ch-name <ecg_ch_name>
-o, --eog-ch-name <eog_ch_name>

input

Create input node.

Use wildcards to run computations on multiple files; To check yourself it’s a good idea to run ls command first like this:

$ ls .//.fif

$ neuropype input .//.fif

neuropype input [OPTIONS] [FIF_FILES]...

Arguments

FIF_FILES

Optional argument(s)

mse

Create multiscale entropy node

Experimental functionality. Available only in mse branch of neuropype_ephy

neuropype mse [OPTIONS]

Options

-m <m>
-r <r>

preproc

Create preprocessing node.

Filter and downsample of raw .fif data

neuropype preproc [OPTIONS]

Options

-l, --l-freq <l_freq>
-h, --h-freq <h_freq>
-d, --ds_freq <ds_freq>

downsampling frequency

psd

Create power computation node.

Lower and higher frequency bounds for computation can be changed

Takes as input epochs in .fif format

EXAMPLE:

$ neuropype pwr input ~/fif_epochs//-epo.fif

neuropype psd [OPTIONS]

Options

--fmin <fmin>

lower frequency bound; default=0

--fmax <fmax>

higher frequency bound; default=300