R/plinko_board-properties.R

In mjskay/plinko: Animated Plinko Boards

#' Get properties of a Plinko board
#'
#' Functions to get different properties of a [plinko_board()].
#'
#' @name plinko_board-properties
#' @param board A [plinko_board()]
#' @return A data frame containing the requested properties of the Plinko board.
NULL

#' @describeIn plinko_board-properties Slot edges
#' @export
slot_edges = function(board) {
  board$slots_df
}

#' @describeIn plinko_board-properties Pin locations
#' @export
pins = function(board) {
  board$pins_df
}

#' @describeIn plinko_board-properties Ball paths from drop point to final location
#' @export
paths = function(board) {
  board$paths_df %>%
    ungroup() %>%
    select(ball_id, move_id, bin, pin, x, y, width, region)
}

#' @describeIn plinko_board-properties Ball final locations
#' @export
balls = function(board) {
  paths(board) %>%
    filter(move_id == max(move_id)) %>%
    mutate(stopped = FALSE, stopped_for = 0)
}

#' @describeIn plinko_board-properties Frames in the animation giving ball locations
#' @export
frames = function(board) {
  frames_df = board$frames_df
  frames_df$stopped_for = frames_df$visible_move_id - frames_df$move_id
  frames_df[,c("frame_id", "ball_id", "move_id", "bin", "pin", "x", "y", "width", "region", "stopped", "stopped_for")]
}

#' @describeIn plinko_board-properties Number of frames in the Plinko board.
#' @export
n_frame = function(board) {
  max(board$frames_df$frame_id)
}