R/pts_matrix_axis.R

In thmshrt/ggshapes: Add 3D-Lite shapes to ggplots

#BEGIN: description
#' Pts for matrix axis
#'
#'
#' @usage
#' pts_matrix_axis()
#'
#' @return
#' [tibble] with columns
#' * `x` x coordinate of point
#' * `y` y coordinate of point
#' * `z` z coordinate of point
#' * `face` is face front, back, top, bottom, left or right
#' * `tb` is the point on top, bottom or middle of face
#' * `rl` is the point on left, right or middle of face
#' * `point_order` points draw order
#' * `face_order`  face draw order for default faces
#'
#' @export
#' @importFrom magrittr %>%
#END: description
#BEGIN: code

pts_matrix_axis = function(
) {
  rlang::abort('not yet implemented')
  ##BEGIN: setup params

  ##END: setup params

  ##BEGIN: param checks

  ##END: param checks

  ##BEGIN: computation

  ##END: computation

  ##BEGIN: return

  ##END: return
}

#END: code
#BEGIN: examples
#' @examples
#' ##BEGIN: example
#' ##END: example
#'
#' ##BEGIN: example
#' ##END: example
#'
#' ##BEGIN: example
#' ##END: example
#END: examples