Function reference • onsetsync

Input functions

Functions for loading data from OSF

get_OSF_csv(): Get csv file from OSF

Annotation functions

Functions for adding extra annotations to onset data.

add_annotation(): add annotation such as the beat cycle starts to the onset data frame

add_isobeats(): Add isochronous times or mean onset times to the data frame

Visualising functions

Functions for visualising onset data.

plot_by_beat(): Plot synchronies by beat structures

plot_by_dataset(): Plot synchronies by beat structures across datasets

plot_by_pair(): Plot synchronies by instrument pairs

plot_by_var_time(): Plots a variables across time and possible by any other structure

plot_by_variable(): Plots synchronies by any other structure

plot_timeline(): Plot onsets across time for instruments.

Synchrony functions

Functions for calculating synchrony from onset data.

sync_execute_pairs(): Calculate asynchronies across all pairs of instruments

sync_joint_onsets(): Determine the number of joint onsets for two instruments

sync_sample_paired(): Take equal number of samples from two instruments

sync_sample_paired_relative(): Compare instrument onset times to mean onset times from several instruments

Periodicity functions

Functions for calculating periodicity from onset data.

period_to_BPM(): Convert period in seconds to Beats Per Minute (BPM)

periodicity(): Estimate the periodicity of the onsets by a specific method

periodicity_nPVI(): Measure of durational variability of events

summarise_periodicity(): Summarise onset periodicities by calculating the moments (mean, etc.)

gaussify_onsets(): Create a continuous vector of onsets with a sampling in Hz

Summary functions

Functions for summarising onset data.

summarise_onsets(): Summarise onsets for instruments specified

summarise_periodicity(): Summarise onset periodicities by calculating the moments (mean, etc.)

summarise_sync(): Summarise synchronies

summarise_sync_by_pair(): Calculate summary statistics for asynchronies by instrument pairs

Datasets

Datasets that come with onsetsync.

Asere_OU_2: Asere_OU_2

DebBh_Drut: DebBh_Drut

CSS_IEMP: CSS_IEMP

Other functions

Function to create a wave file from the onset data.

synthesise_onsets(): Synthesise onsets with noises and clicks