Skip to content

Commit

Permalink
Improve docs for the above function.
Browse files Browse the repository at this point in the history
  • Loading branch information
MHenderson committed Mar 28, 2024
1 parent 30ed168 commit 1757626
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 9 deletions.
13 changes: 9 additions & 4 deletions R/above.R
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
#' Superimpose two grobs, one above the other.
#' Superimpose two pictures, one above the other.
#'
#' @param p A grob
#' @param q Another grob
#' `above` returns a new picture made by placing the first input picture
#' above the second input picture. The user can also provide arguments `m`
#' and `n` in which case the pictures will be placed so that they occupy the
#' output picture in a m:n ratio.
#'
#' @param p A `grid::grob` picture
#' @param q Another `grid::grob` picture
#' @param m An integer
#' @param n Another integer
#' @return A new grob obtained by superimposing p and q, one above the other.
#' @return A new `grid::grob` picture obtained by superimposing p and q, one above the other.
#' @export
above <- function(p, q, m = 1, n = 1) {
fg <- grid::frameGrob(layout = grid::grid.layout(2, 1))
Expand Down
13 changes: 8 additions & 5 deletions man/above.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 1757626

Please sign in to comment.