diff --git a/R/flip.R b/R/flip.R index ad1733f..310bfb3 100644 --- a/R/flip.R +++ b/R/flip.R @@ -1,7 +1,10 @@ -#' Flip a grob. +#' Flip a picture #' -#' @param g A grob -#' @return Flipped grob +#' `flip` returns a new picture made by flipping the input picture along +#' its vertical centre axis. +#' +#' @param g A `grid::grob` picture +#' @return A flipped `grid::grob` picture #' @export flip <- function(g) { grid::editGrob(g, x = grid::unit(1, "npc") - g$x) diff --git a/man/flip.Rd b/man/flip.Rd index a061fcb..4c83e8f 100644 --- a/man/flip.Rd +++ b/man/flip.Rd @@ -2,16 +2,17 @@ % Please edit documentation in R/flip.R \name{flip} \alias{flip} -\title{Flip a grob.} +\title{Flip a picture} \usage{ flip(g) } \arguments{ -\item{g}{A grob} +\item{g}{A `grid::grob` picture} } \value{ -Flipped grob +A flipped `grid::grob` picture } \description{ -Flip a grob. +`flip` returns a new picture made by flipping the input picture along +its vertical centre axis. }