R/pos_honeycomb_y.R

In EvaMaeRey/ggstamp: Annotation in ggplot using stamp_* functions

#' Create vector for y that, with x will, form a wrapping honeycomb pattern
#'
#' @inheritParams pos_honeycomb
#'
#' @return
#' @export
#'
#' @examples
#' pos_honeycomb_y()
#' ggcanvas() +
#'  stamp_polygon(x0 = pos_honeycomb_x(),
#'                y0 = pos_honeycomb_y())
pos_honeycomb_y <- function(y0 = 0, n = 5, ncol = 3, height = 1.5){

  -(0:(n-1) %/% ncol)*height + y0

}