Fix generic function signatures so they match. (#23)

* Fix generic function signatures so they match.

* Fix a couple more function signatures.

* Update docs.

* A few small documentation corrections.

* Another documentation fix.

DESCRIPTION

@@ -8,6 +8,6 @@ Description: Peter Henderson's Functional Geometry in R.
 License: MIT + file LICENSE
 Imports:
     grid
-RoxygenNote: 5.0.1
+RoxygenNote: 7.2.3
 URL: https://github.com/mhenderson/funcgeo
 BugReports: https://github.com/mhenderson/funcgeo/issues

R/above-grob.R

@@ -1,5 +1,6 @@
 #' Superimpose two grobs, one above the other.
 #'
+#' @param p A grob
 #' @param q Another grob
 #' @param m An integer
 #' @param n Another integer

R/above.R

@@ -1,8 +1,11 @@
 #' Superimpose two pictures, one above the other.
 #'
 #' @param p A picture
+#' @param q Another picture
+#' @param m An integer
+#' @param n Another integer
 #' @return A picture
 #' @export
-above <- function(picture, ...) {
-  UseMethod("above", picture)
+above <- function(p, q, m, n) {
+  UseMethod("above")
 }

R/beside-grob.R

@@ -1,6 +1,9 @@
 #' Superimpose two grobs side-by-side.
 #'
-#' @param g grob
+#' @param p grob
+#' @param q grob
+#' @param m An integer
+#' @param n Another integer
 #' @return A grob
 #' @export
 beside.grob <- function(p, q, m = 1, n = 1) {

R/beside.R

@@ -1,8 +1,12 @@
 #' Superimpose two grobs, side-by-side.
 #'
-#' @param p A picture
+#' @param p grob
+#' @param q grob
+#' @param m An integer
+#' @param n Another integer
+#' @return A grob
 #' @return A picture
 #' @export
-beside <- function(picture, ...) {
-  UseMethod("beside", picture)
+beside <- function(p, q, m = 1, n = 1) {
+  UseMethod("beside", p)
 }

R/cycle.R

@@ -1,7 +1,7 @@
 #' Cycle
 #'
-#' @param g grob
-#' @return A grob
+#' @param p A picture
+#' @return A picture
 #' @export
 cycle <- function(p) {
   return(quartet(p, rot(rot(rot(p))), rot(p), rot(rot(p))))

R/flip.R

@@ -1,8 +1,8 @@
 #' Flip a picture.
 #'
-#' @param picture A picture
+#' @param g A picture
 #' @return Flipped picture
 #' @export
-flip <- function(picture, ...) {
-  UseMethod("flip", picture)
+flip <- function(g) {
+  UseMethod("flip", g)
 }

R/plot-picture.R

@@ -1,8 +1,9 @@
 #' plot.picture
 #'
-#' @param picture A picture
+#' @param x A picture
+#' @param ... Anything else.
 #' @return grid.draw(picture)
 #' @export
-plot.picture <- function(picture) {
-  grid::grid.draw(picture)
+plot.picture <- function(x, ...) {
+  grid::grid.draw(x)
 }

R/rot-grob.R

@@ -1,6 +1,7 @@
 #' Rotate a grob.
 #'
 #' @param g A grob
+#' @param angle An angle
 #' @return Rotated grob
 #' @export
 rot.grob <- function(g, angle = 90) {

R/rot.R

@@ -1,8 +1,9 @@
 #' Rotate a picture.
 #'
-#' @param picture A picture
+#' @param g A picture
+#' @param angle An angle
 #' @return Rotated picture
 #' @export
-rot <- function(picture, ...) {
-  UseMethod("rot", picture)
+rot <- function(g, angle) {
+  UseMethod("rot", g)
 }