MEA {rMEA}

MEA class constructor

Description

The preferred way to create an object of class MEA is through the function readMEA.

Usage

MEA(
  dataframe,
  sampRate,
  filter = "raw",
  id,
  session,
  group,
  s1Name,
  s2Name,
  uid = paste(group, id, session, sep = "_")
)

is.MEA(x)

Arguments

dataframe

a data frame with 2 columns containing MEA data respectively for subject 1 (s1) and subject 2 (s2).

sampRate

integer. The sampling rate of the MEA data. Normally derived from the framerate of the analyzed video sequence (frames per second; fps).

filter

a string describing the pre-processing that has been applied on the raw data.

id

a string representing a unique identifier of the dyad that the MEA data belong to.

session

an integer representing the session (or experiment, interaction, etc); if each dyad is measured only once, the default value is 1.

group

a string naming the group the dyad belongs to, such as diagnostic group, clinic, etc.

s1Name

a string naming subject 1.

s2Name

a string naming subject 2.

uid

a string providing a unique identifier of the file. By default 'group_id_session'.

x

object to be tested.

Details

It is advised to not create the MEA object manually but to always use the function readMEA instead.

Value

A list containing three objects:

MEA: the dataframe containing the motion energy data

ccf: the matrix of lagged cross-correlations between s1 and s2 (if MEAccf was run)

ccfRes: some useful row marginals

is.MEA returns TRUE if and only if its argument is of class MEA