R/chartFngMapping.R

In Eve-ning/osutools: osu! file Mangler

#' Creates the mapping to be used alongside with the broadcasted chart.
#'
#' @description
#' Using the broadcasted format, this function maps the values provided by
#' mapping
#'
#' This can also be skipped if you're doing a custom mapping
#'
#' @param chart.keyset.select A character vector based on type of chart.keyset.
#'
#' Either chart.keyset or chart.keyset.select must be defined
#'
#' Valid chart.keyset.select values are
#'
#' '4', '5L', '5R', '6', '7L', '7R', '8SPR', '8SPL','8SYM', '9L', '9R'
#'
#' Only 8K has special chart.keysets
#'
#' 8SYM: 8 Key Symmetry
#'
#' 8SPL: 8 Key Special (Left)
#'
#' 8SPR: 8 Key Special (Right)
#'
#' This can also accept just '8', however it'll default to a Right Hand
#' Playstyle. Use specific styles for precision.
#'
#' @param chart.keyset A data.frame based on type of chart.keyset.
#'
#' Either chart.keyset or chart.keyset.select must be defined
#'
#' Fingers are denoted as
#' P|inky
#' R|ing
#' M|iddle
#' I|ndex
#' T|humb
#'
#' Column keys and fingers is required.
#'
#' An example of chart.keyset would be
#'
#' 7R = data.frame(keys = 1:7, fingers = c(2,3,4,6,7,8,9))
#'
#' @param include.details A Logical to indicate if
#' details should be calculated
#'
#' Directions
#'
#' Directions is a character vector indicating what type of motion it is.
#'
#' "across" means moves from hand to hand
#'
#' "jack" is self-explanatory
#'
#' "in" is where the motion is leading towards the thumb
#'
#' "out" is where the motion is leading to the pinkies
#'
#' Distance is the number of columns between the pair of notes
#'
#' rfls is the ave distance from the center, (5.5).
#' rfls stands for reflections, as it's the method used to calculate.
#'
#' @importFrom magrittr %<>%
#' @importFrom dplyr mutate select
#' @importFrom stringr str_replace
#' @importFrom reshape2 melt
#' @importFrom rlang .data
#'
#' @export

chartFngMapping <- function(chart.keyset.select=NA,
                            chart.keyset=NA,
                            include.details=T){

  loadMapping <- function(mapping){
    fngr <- merge(1:10, 1:10)
    colnames(fngr) <- c("fngs.tos", "fngs.froms")
    return(fngr)
  }

  # Chooses between chart.keyset or chart.keyset.select, if both NA, stop()
  loadchart.keyset <- function(chart.keyset, chart.keyset.select){
    if (!is.na(chart.keyset)){
      return(chart.keyset)
    } else if (!is.na(chart.keyset.select)){
      move.chart.keysets <- .dflt.move.keysets()
      return(move.chart.keysets[[as.character(chart.keyset.select)]])
    } else {
      stop("Either chart.keyset or chart.keyset.select must be defined.")
    }
  }

  # Merges both data.frames together
  mergeMapping <- function(mapping, chart.keyset) {
    mapping %<>%
      merge(chart.keyset, by.x = 'fngs.froms', by.y = 'fingers')
    colnames(mapping)[ncol(mapping)] <- "keys.froms"

    mapping %<>%
      merge(chart.keyset, by.x = 'fngs.tos', by.y = 'fingers')
    colnames(mapping)[ncol(mapping)] <- "keys.tos"

    return(mapping)
  }

  getDetails <- function(mapping) {
    mapping %<>%
      dplyr::mutate(
        # Read the document above for details about these parameters

        directions = 'in',
        distances = abs(.data$keys.tos - .data$keys.froms),

        fngs.tos.rfls = abs(.data$fngs.tos - 5.5),
        fngs.froms.rfls = abs(.data$fngs.froms - 5.5),
        rfls = (.data$fngs.tos.rfls + .data$fngs.froms.rfls) / 2,
        directions = ifelse(.data$fngs.tos.rfls > .data$fngs.froms.rfls,
                           'out', .data$directions),

        directions = ifelse(.data$fngs.tos == .data$fngs.froms,
                           'jack', .data$directions),

        fngs.tos.left = .data$fngs.tos < 5.5,
        fngs.froms.left = .data$fngs.froms < 5.5,
        directions = ifelse(xor(.data$fngs.tos.left, .data$fngs.froms.left),
                           'across', .data$directions)
      )  %>%
      dplyr::select(1:6, .data$rfls)

    return(mapping)
  }



  move.mapping <- loadMapping()
  move.chart.keyset <- loadchart.keyset(chart.keyset,
                                        as.character(chart.keyset.select))

  move.mapping %<>%
    mergeMapping(move.chart.keyset)

  if (include.details) {
      move.mapping %<>% getDetails()
  }

  return(move.mapping)
}