R/calc_duration.R

In tca2/birdseyevyu: Prepare and Create Output from datavyu Coding Files

#' Calculate the duration of a code for a datavyu column
#'
#' @param column the column as a character string
#' @param code the code as a character string
#' @param directory the path to the directory as a character string
#' @param by_file whether or not to calculate the frequencies by file (logical)
#' @return A data frame generated with the janitor package
#' @importFrom rlang .data

calc_duration <- function(column = NULL,
                          code = NULL,
                          directory = NULL,
                          by_file = FALSE) {

  # argument check
  if (is.null(column)) {
    stop("Please specify a column name to tabulate via the `column_name` argument")
  }

  df_of_codes <- datavyur::import_datavyu(column = column,
                                         folder = directory) %>%
    tibble::as_tibble() %>%
    dplyr::select(1:5, dplyr::all_of(code))

  # this is if a code name is not provided
  if (is.null(code)) {
    code <- names(df_of_codes)[stringr::str_detect(names(df_of_codes), "code01")]
    if (length(code) < 1) {
      stop("Please specify a code name to tabulate via the `code_name` argument")
    }
  }

  index_for_onset <- stringr::str_detect(names(df_of_codes), "onset")
  names(df_of_codes)[index_for_onset] <- "onset"

  index_for_offset <- stringr::str_detect(names(df_of_codes), "offset")
  names(df_of_codes)[index_for_offset] <- "offset"

  if (by_file == FALSE) {

    out <- df_of_codes %>%
      dplyr::group_by(!!rlang::sym(code)) %>%
      dplyr::mutate(duration = dplyr::if_else(.data$offset > .data$onset, .data$offset - .data$onset, .data$onset - .data$offset)) %>%
      dplyr::summarize(sum_duration = sum(.data$duration, na.rm = TRUE)) %>%
      dplyr::mutate(percent = .data$sum_duration / sum(.data$sum_duration)) %>%
      dplyr::arrange(dplyr::desc(.data$sum_duration)) %>%
      #dplyr::mutate_at(dplyr::vars(.data$sum_duration), datavyur::ms2time) %>%
      dplyr::rename(duration = .data$sum_duration) %>%
      tibble::as_tibble()

  } else {

    list_of_times <- df_of_codes %>%
      dplyr::group_by(file) %>%
      dplyr::group_split()

    names(list_of_times) <- unique(df_of_codes$file)

    out <- list_of_times %>%
      purrr::map_df(~., .id = "id") %>%
      dplyr::select(-.data$id) %>% # why is there this and file? not sure
      dplyr::group_by(file, !!rlang::sym(code)) %>%
      dplyr::mutate(duration = dplyr::if_else(.data$offset > .data$onset, .data$offset - .data$onset, .data$onset - .data$offset)) %>%
      dplyr::summarize(sum_duration = sum(.data$duration, na.rm = TRUE)) %>%
      dplyr::arrange(file, dplyr::desc(.data$sum_duration)) %>%
      dplyr::mutate(percent = .data$sum_duration / sum(.data$sum_duration)) %>%
      #dplyr::mutate_at(dplyr::vars(.data$sum_duration), datavyur::ms2time) %>%
      dplyr::rename(duration = .data$sum_duration) %>%
      tibble::as_tibble()

  }

  out
}