Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nguyen-td committed Mar 19, 2024
1 parent 63aed0b commit 5a081c3
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion pop_roi_connect.m
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@
% 'TRDTF' : Time-reversed directed transfer entropy
% 'MIM' : Multivariate Interaction Measure for each ROI
% 'MIC' : Maximized Imaginary Coherency for each ROI
% 'PAC' : Phase-amplitude coupling between ROIs
% 'PAC' : Phase-amplitude coupling between ROIs (see the 'fcomb' and 'bs_outopts' input parameters)
% 'TDE' : Time-delay estimation between two selected ROIs (see the 'tde_regions' and 'tde_freqbands' input parameters)
% 'snippet' - ['on'|off] Option to compute connectivity over snippets. Default is 'off'.
% 'firstsnippet' - ['on'|off] Only use the first snippet (useful for fast computation). Default is 'off'.
% 'snip_length' - ['on'|'off'] Length of the snippets. Default is 60 seconds.
Expand All @@ -50,6 +51,10 @@
% 5 - only store: b_anti, b_anti_norm
% 'roi_selection' - [cell array of integers] Cell array of ROI indices {1, 2, 3, ...} indicating for which regions (ROIs) connectivity should be computed.
% Default is empty (in this case, connectivity will be computed for all ROIs).
% 'tde_regions' - [seed target] Array containing the seed and target region for time-delay estimation. Regions need to be passed as region *indices*,
% e.g., [2 10] will compute time-delays from region 2 -> 10 and 10 -> 2, corresponding to the information flow in both directions separately.
% Default is [] (will throw an error).
% 'tde_freqbands' - [f1 f2] Array containing the frequency band for which bispectral time-delays will be estimated. Default is [] (broadband).
% 'conn_stats' - ['on'|'off'] Run statistics on connectivity metrics. Default is 'off'.
% 'nshuf' - [integer] number of shuffles for statistical significance testing. The first shuffle is the true value. Default is 1001.
% 'freqrange' - [min max] frequency range in Hz. This is used to compute and plot p-values. Default is to plot broadband power.
Expand Down

0 comments on commit 5a081c3

Please sign in to comment.