eelbrain.testnd.Correlation

class eelbrain.testnd.Correlation(y, x, norm=None, sub=None, data=None, samples=10000, pmin=None, rmin=None, tfce=False, tstart=None, tstop=None, match=None, parc=None, **criteria)[source]

Mass-univariate Pearson correlation significance test

Parameters:

  • y (NDVar | str) – Dependent variable.

  • x (Var | str) – The continuous predictor variable.

  • norm (Factor | Interaction | NestedEffect | str) – Categories in which to normalize (z-score) x.

  • sub (Var | ndarray | str) – Perform the test with a subset of the data.

  • data (Dataset) – If a Dataset is specified, all data-objects can be specified as names of Dataset variables.

  • samples (int) – Number of samples for permutation test (default 10,000).

  • pmin (float) – Threshold for forming clusters (0 < pmin < 1): use an r-value equivalent to an uncorrected p-value.

  • rmin (float) – Threshold for forming clusters.

  • tfce (float | bool) – Use threshold-free cluster enhancement. Use a scalar to specify the step of TFCE levels (for tfce is True, 0.1 is used).

  • tstart (float) – Start of the time window for the permutation test (default is the beginning of y).

  • tstop (float) – Stop of the time window for the permutation test (default is the end of y).

  • match (Factor | Interaction | NestedEffect | str) – When permuting data, only shuffle the cases within the categories of match.

  • parc (str) – Collect permutation statistics for all regions of the parcellation of this dimension. For threshold-based test, the regions are disconnected.

  • mintime (float) – Minimum duration for clusters (in seconds).

  • minsource (int) – Minimum number of sources per cluster.

clusters

For cluster-based tests, a table of all clusters. Otherwise a table of all significant regions (or None if permutations were omitted). See also the find_clusters() method.

Type:

eelbrain._data_obj.Dataset

p

Map of p-values corrected for multiple comparison (or None if no correction was performed).

Type:

eelbrain._data_obj.NDVar

p_uncorrected

Map of p-values uncorrected for multiple comparison.

Type:

eelbrain._data_obj.NDVar

r

Map of correlation values (with threshold contours).

Type:

eelbrain._data_obj.NDVar

tfce_map

Map of the test statistic processed with the threshold-free cluster enhancement algorithm (or None if no TFCE was performed).

Type:

eelbrain._data_obj.NDVar

See also

testnd

Information on the different permutation methods

Methods

cluster(cluster_id)

Retrieve a specific cluster as NDVar

compute_probability_map(**sub)

Compute a probability map

find_clusters([pmin, maps])

Find significant regions or clusters

find_peaks()

Find peaks in a threshold-free cluster distribution

info_list([computation])

List with information about the test

masked_parameter_map([pmin])

Statistical parameter map masked by significance