Document cycle (#46)

* Document the cycle function.

* Minor clarification for the rot documentation.

R/cycle.R

@@ -1,7 +1,13 @@
-#' Cycle
+#' Create a 2 by 2 grid pattern of rotated pictures
 #'
-#' @param p A grob
-#' @return A grob
+#' `cycle` returns a 2 by 2 grid pattern of four pictures, each obtained from
+#' the input `grid::grob` picture `p`. In the top left position of the grid
+#' is `p`, in the bottom-right position is the picture `p` rotated by 90 degrees.
+#' In the bottom-left position `p` is rotated through 180 degrees and in the
+#' top-right position `p` is rotated through 270 degrees.
+#'
+#' @param p A `grid::grob` for the top-left position
+#' @return A `grid::grob` made up of rotations of the four input pictures arranged in a 2 by 2 grid pattern.
 #' @export
 cycle <- function(p) {
   return(quartet(p, rot(rot(rot(p))), rot(p), rot(rot(p))))

R/rot.R

@@ -1,8 +1,8 @@
 #' Rotate a picture
 #'
 #' `rot` returns a new picture, made by rotating the input picture. If no angle
-#' is specified then the new picture will be rotated 90 degrees. A different
-#' angle can be specified with the `angle` argument.
+#' is specified then the new picture will be rotated clockwise by 90 degrees. A
+#' different angle can be specified with the `angle` argument.
 #'
 #' @param g A `grid::grob` picture
 #' @param angle An angle