Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Code Modules for *Finding Structure in Time: Visualizing and Analyzing Behavioral Time Series*

This is the github repository containing the four Matlab code modules with sample examples introduced in the paper, *Finding Structure in Time: Visualizing and Analyzing Behavioral Time Series*. [Here](https://psyarxiv.com/mpz9g/) is a preprint of the paper. These code modules aim to facilitate behavioral researchers to interpret and analyze high-density multi-modal behavior data, namely, to:
1) visualize the raw behavioral time series,
2) describe the distributional structure of temporal events: Burstiness calculation. This is a method to quantify the temporal regularity of occurrence of events (Goh & Barabási, 2008),
3) characterize the nonlinear dynamics over multiple timescales with Cross-Recurrence Quantification Analysis (CRQA) (Zbilut, Giuliani & Webber, 1998),
4) and quantify the directional relations among a set of interdependent multimodal behavioral variables with Granger Causality Granger, 1969; Bressler & Seth, 2011).
The four methods are complementary to each other, yet each module is standalone. Users can use any specific module as desired.
This is the github repository containing the five Matlab code modules with sample data and results introduced in the paper, *Finding Structure in Time: Visualizing and Analyzing Behavioral Time Series*. [Here](https://psyarxiv.com/mpz9g/) is a preprint of the paper. These code modules aim to facilitate behavioral researchers with varying degrees of programming skills to interpret and analyze high-density multi-modal behavior data.

The five modules include:
1) a step-by-step “programming basics” tutorial that introduces novice programmers to common behavioral timeseries data as well as scripts necessary to import and manipulate these data. It also provides scripts for transforming data to and from common data formats used across all modules to facilitate modifying module material to work with user data,
2) scripts to visualize the raw behavioral time series,
3) scripts to describe the distributional structure of temporal events: Burstiness calculation. This is a method to quantify the temporal regularity of occurrence of events (Goh & Barabási, 2008),
4) scripts to characterize the nonlinear dynamics over multiple timescales with Cross-Recurrence Quantification Analysis (CRQA) (Zbilut, Giuliani & Webber, 1998),
5) scripts to quantify the directional relations among a set of interdependent multimodal behavioral variables with Granger Causality Granger, 1969; Bressler & Seth, 2011).

The five modules are complementary to each other, yet each module is standalone. Novice programmers will benefit most from the modules if they carefully work through the material in Modules 1 and 2 before attempting to run or modify the later modules. More experienced programmers can more selectively focus on the modules of greatest interest to them, modifying scripts to meet their own analysis goals.

## System requirement and Matlab installation
Our scripts can be run on Matlab version 2018a and later versions. Matlab is available on all three main types of operating systems: Windows, macOS, and Linux. While Matlab is not free and open source which presents limitations to our users, many institutions offer Matlab for free. One can check this following website to see if a free campus license is available [here](https://www.mathworks.com/academia/tah-support-program/eligibility.html). [Here](https://www.mathworks.com/help/install/ug/install-and-activate-without-an-internet-connection.html) are the instructions for Matlab installation. Alternatively, users can install and run our code modules on GNU Octave which is open source and runs on GNU/Linux, macOS, BSD, and Windows. [This page](https://www.gnu.org/software/octave/#install) contains the installation information for GNU Octave.
Expand Down