An internal function, a legacy implementation to compute Surrogate Synchrony, please use susy function instead.
Cross-correlations are computed up to a specific lag in seconds Maxlag, then aggregated within a chosen Segment of e.g. 30s. Aggregation is performed by transforming correlations to Fisher's Z, then computing mean Z in each segment, then across all segments of the time series. Segment shuffling is used to create surrogate time series, on which the same computations are run. This provides effect sizes ES. File: The pairs of time series are in the columns of the file, variable names are in the header line. If Automatic is clicked, the synchrony is computed of all adjacent pairs of columns in the file. If Automatic is unclicked, you may choose the two columns to be analyzed for synchrony, and two plots are additionally prepared. SUSY provides two different synchrony measures of each twin time series: mean Z and ES of mean Z; mean absolute_Z and ES of mean absolute_Z.

old.susy(
  filename="MEA-topstage-C3-Beethoven.txt", separator=" ", missings=".", datahead=TRUE,
  spalte1=2, spalte2=5, epoche=30, fps=15, maxlag=3, automatic=FALSE,
  plotid=3, plotid2=5, pseudosVereinfachen=FALSE, anzahlPseudosGesamt=500,
  zufallsdaten=FALSE, anzahlzufallsdaten=10000, korrOhneBetragAnzeigen=TRUE,
  permutation=FALSE
)

Arguments

filename

Character scalar, name of a source file. Defaults to "MEA-topstage-C3-Beethoven.txt".

separator

Character scalar, source file data separator. Defaults to " ".

missings

Character scalar, source file data missings marker. Defalts to ".".

datahead

Logical scalar, tells if source data has a header row. Defaults to TRUE.

spalte1

Numeric, first column number of data to use. Defaults to 2.

spalte2

Numeric, second column number of data to use. Defaults to 5.

epoche

Epochengroesse (SEGMENT SIZE) in s (Epoche darf nicht kleiner sein als Zeitfenster/fps). Epoche*fps darf nicht groesser sein als die Anzahl Daten (timepoints) geteilt durch 2. Beispiel 1: timepoints: 1000, fps = 10, also darf Epoche nicht groesser sein als 50s (=1000/(10*2)). Beispiel 2: maxlag : 90, fps = 10, also darf Epoche nicht KLEINER sein als 9s (=90/10).

fps

Numeric, frames per second, sampling rate.

maxlag

Numeric, window size for CCF, maximum lag in seconds, only whole number.

automatic

Logical, if TRUE then all pairs of columns are computed, therefore number of columns must be even and also a plot is not generated.

plotid

Numeric, specifies the type of the first plot, defaults to 3. 1: GMcrosscorrs, 2: synchrony by epoch, 3: GM-Z, 4: time series plot, 5: z not abs.

plotid2

Numeric, specifies the type of the first plot, defaults to 5.

pseudosVereinfachen

Logical, default FALSE. Simplify calculation of the pseudo data.

anzahlPseudosGesamt

Numeric, default 500. Ignored when pseudosVereinfachen is FALSE (default)

zufallsdaten

Logical, if TRUE then use random data, normally distributed numbers in the range [0,50].

anzahlzufallsdaten

Numeric, number of rows in random data.

korrOhneBetragAnzeigen

Logical, defaults to TRUE display correlation without the amount.

permutation

Logical, if TRUE then function computes all pairs combinations between columns provided in x (n*(n-1)/2 pairs)

Note

Function does not handle missing values.

Value

Returns NULL invisibly. A side effects include:

  • output to console, its form depends on korrOhneBetragAnzeigen argument.

  • plots, according to plotid1 and plotid2 arguments.

  • file "CrossCorrelations.txt" written to current working directory, if plotid1 or plotid2 specifies plot type 1.

See also