R/period_to_BPM.R

In tuomaseerola/onsetsynch: Analysis and Visualisation of Synchronisation of Music Onset Data

#' Convert period in seconds to Beats Per Minute (BPM)
#'
#' Converts period in seconds to BPM
#'
#' @param period data frame to be processed (required)
#' @param beats_per_minute baseline assumption of how many beats there are in minute (default 60)
#' @seealso \code{\link{summarise_periodicity}},\code{\link{periodicity}}
#' @return Numeric output
#' @export
#' @examples
#' bpm <- period_to_BPM(0.666)
#' print(bpm)

period_to_BPM <-
  function(period = NULL, 
           beats_per_minute = 60) {
    # T. Eerola, Durham University, IEMP project
    # 22/4/2021
    
    p <- 1 / period * beats_per_minute

    return <- p
  }