movementsync (version 0.1.5)

summary_onsets: Summary of difference in onsets

Description

Summary of difference in onsets

Usage

summary_onsets(
  onset_obj,
  recording,
  instruments,
  splicing_dfr = NULL,
  expr = NULL,
  show_plot = FALSE,
  filter_pair = NULL,
  na_omit = TRUE,
  time_breaks = NULL
)

Value

a summary data frame of onset difference statistics.

Arguments

onset_obj

OnsetsSelected object.

recording

Recording object.

instruments

character vector of instrument names.

splicing_dfr

Splice object

expr

R expression to subset onsetsSelected

show_plot

show a plot? (Default is FALSE).

filter_pair

regular expression to filter instrument pair names.

na_omit

omit NAs (Default is TRUE).

time_breaks

suggests the number of major time tick marks (default is NULL).

See Also

Other statistical and analysis functions: apply_column_spliceview(), apply_segment_spliceview(), ave_cross_power_over_splices(), ave_cross_power_spliceview(), ave_power_over_splices(), ave_power_spliceview(), calculate_ave_cross_power1(), calculate_ave_power1(), compare_ave_cross_power1(), compare_ave_power1(), compare_avg_cross_power2(), compare_avg_power2(), difference_onsets(), pull_segment_spliceview(), sample_gap_splice(), sample_offset_splice(), visualise_sample_splices()

Examples

r1 <- get_sample_recording()
o1 <- get_onsets_selected_data(r1)
d1 <- get_duration_annotation_data(r1)
splice_dfr <- splice_time(d1, tier = 'FORM')
summary_onsets(o1, r1, instruments = c('Inst', 'Tabla'),
  splicing_dfr = splice_dfr, show_plot = TRUE)