revision => vignette + documentation 📝

Author: Kevin Cazelles

NAMESPACE

@@ -61,7 +61,6 @@ importFrom(graphics,points)
 importFrom(graphics,rect)
 importFrom(graphics,text)
 importFrom(magrittr,"%<>%")
-importFrom(magrittr,"%>%")
 importFrom(stats,aggregate)
 importFrom(stats,quantile)
 importFrom(stats,rnorm)

R/arrows2.R

@@ -1,6 +1,6 @@
 #' Add arrows to a plot.
 #'
-#' Draw arrows between pairs of points. Arrows drawn are fully customizable by using parameters of `polygon` function.
+#' Draw a custom arrows between pairs of points.
 #'
 #' @export
 #'
@@ -14,7 +14,7 @@
 #' @param cex.shr the magnification coefficient to be used to change the height of arrows towards their heads.
 #' @param cex.hl the magnification coefficient to be used for the lengths of arrows' head.
 #' @param cex.hh the magnification coefficient to be used for the heights of arrows' head.
-#' @param prophead logical. If TRUE arrows are drawn with head proportionnal to the length of the arrows.
+#' @param prophead logical. If TRUE arrows are drawn with head proportional to the length of the arrows.
 #' @param twoheaded logical. If TRUE two-headed arrows are drawn, default is FALSE.
 #' @param ... additional arguments to be passed to `polygon` function.
 #'
@@ -35,10 +35,10 @@
 #' arrows2(runif(2), runif(2), x1=runif(2), y1=runif(2), prophead=FALSE, lty=3)
 
 
-arrows2 <- function(x0, y0, x1 = x0, y1 = y0, off0 = 0, off1 = off0, cex.arr = 1, 
+arrows2 <- function(x0, y0, x1 = x0, y1 = y0, off0 = 0, off1 = off0, cex.arr = 1,
     cex.shr = 1, cex.hh = 1, cex.hl = 1, prophead = TRUE, twoheaded = FALSE, ...) {
     stopifnot(all(c(off0, off1)^2 < 1))
-    ## ---- Format checkings / adjusting vectors sizes
+    ## ---- Format checking / adjusting vectors sizes
     argn <- c("x0", "y0", "x1", "y1")
     argo <- list(x0, y0, x1, y1)
     sz <- max(sapply(list(x0, y0, x1, y1), length))
@@ -48,7 +48,7 @@ arrows2 <- function(x0, y0, x1 = x0, y1 = y0, off0 = 0, off1 = off0, cex.arr = 1
     rx <- (x1 - x0)
     ry <- (y1 - y0)
     distpt <- sqrt(rx * rx + ry * ry)
-    # ----- Checkings
+    # ----- Checking
     pb <- which(distpt == 0)
     if (length(pb) > 0) {
         warning("Zero-length arrows are skipped.")
@@ -84,15 +84,16 @@ arrows2 <- function(x0, y0, x1 = x0, y1 = y0, off0 = 0, off1 = off0, cex.arr = 1
             sqptx <- rep(x0[i], 7) + c(0, lg2, lg2, lg1, lg2, lg2, 0)
             sqpty <- rep(y0[i], 7) + c(hg1, hg2, hg3, 0, -hg3, -hg2, -hg1)
         } else {
-            sqptx <- rep(x0[i], 12) + c(0, lg3, lg3, 0.5 * lg1, lg2, lg2, lg1, lg2, 
+            sqptx <- rep(x0[i], 12) + c(0, lg3, lg3, 0.5 * lg1, lg2, lg2, lg1, lg2,
                 lg2, 0.5 * lg1, lg3, lg3)
-            sqpty <- rep(y0[i], 12) + c(0, hg3, hg2, hg1, hg2, hg3, 0, -hg3, -hg2, 
+            sqpty <- rep(y0[i], 12) + c(0, hg3, hg2, hg1, hg2, hg3, 0, -hg3, -hg2,
                 -hg1, -hg2, -hg3)
         }
         ## ----
-        ptcoord <- rotation(sqptx, sqpty, rot = anglept[i], xrot = x0[i], yrot = y0[i], 
+        ptcoord <- rotation(sqptx, sqpty, rot = anglept[i], xrot = x0[i], yrot = y0[i],
             rad = TRUE)
         graphics::polygon(ptcoord$x, ptcoord$y, ...)
     }
+    ## ----
     invisible(NULL)
 }

R/compassRose.R

@@ -26,7 +26,7 @@
 #' compassRose(0, rot=25, cex.cr = 2, col.let =2, add = FALSE)
 
 #' @export
-#' @describeIn compassRose A compass rose with the four cardinal directions and additionnal directions.
+#' @describeIn compassRose A compass rose with the four cardinal directions and additional directions.
 compassRose <- function(x = 0, y = 0, labels = c("S", "W", "N", "E"), rot = 0, cex.cr = 1,
     cex.let = cex.cr, col.cr = c(1, 8), col.let = 1, border = c(1, 8), offset = 1.2,
     add = TRUE, ...) {

R/contrastColors.R

@@ -11,15 +11,14 @@
 #'
 #' @details
 #' Based on the sum of colors' saturation \code{how_borw} returns black or white,
-#' \code{how_prop} proportially remove or add some saturation. \code{how_oppo}
+#' \code{how_prop} proportionally remove or add some saturation. \code{how_oppo}
 #' opposes the color (255-x) and \code{how_cent} centers the columns, i.e. remove
 #' or add 127.
 #'
 #' @seealso
 #' \link[grDevices]{col2rgb}
 #'
 #' @importFrom grDevices col2rgb
-#' @importFrom magrittr %>%
 #' @export
 #'
 #' @examples
@@ -30,20 +29,20 @@
 
 #' @describeIn contrastColors Retuns a set of colors contrasted.
 contrastColors <- function(colors, how = "how_borw", alpha = FALSE) {
-    out <- colors %>% col2rgb(alpha = alpha) %>% apply(2L, how) %>% apply(2L, intToHex)
+    out <- apply(apply(col2rgb(colors, alpha = alpha), 2L, how), 2L, intToHex)
     paste0("#", out)
 }
 
 #' @export
 #' @describeIn contrastColors Retuns the hexadecimal string associates to a given vector of colors.
 col2Hex <- function(colors, alpha = FALSE) {
-    out <- colors %>% col2rgb(alpha = alpha) %>% apply(2L, intToHex)
+    out <- apply(col2rgb(colors, alpha = alpha), 2L, intToHex)
     paste0("#", out)
 }
 
 how_borw <- function(x) {
     out <- x
-    if (sum(x[1L:3L]) > 382) 
+    if (sum(x[1L:3L]) > 382)
         out[1L:3L] <- 0 else out[1L:3L] <- 255
     out
 }

R/darken.R

@@ -1,6 +1,6 @@
 #' Lighten or darken colors
 #'
-#' Returns lightened or darkened colors, vetorized over `percentage`.
+#' Returns lightened or darkened colors, vectorised over `percentage`.
 #' `ramp` is valid for any couple of colors. Functions `darken` and
 #' `lightened` actually call `ramp` to darken and lighten a given color.
 #'
@@ -21,7 +21,7 @@
 ramp <- function(fromcol, tocol, percentage = 50, as_rgb = FALSE) {
     perc <- as.integer(percentage)
     outcol <- (grDevices::colorRampPalette(c(fromcol, tocol)))(101)[perc + 1]
-    if (as_rgb) 
+    if (as_rgb)
         outcol <- grDevices::col2rgb(outcol)
     return(outcol)
 }

R/donut.R

@@ -18,7 +18,7 @@
 #' @param add a logical. Should the donut chart be added on the current graph? If `FALSE` then a new plot is created.
 #' @param border the border color of the donut, set to `NA` which omits borders.
 #' @param clockwise a logical. Shall slices be drawn clockwise?
-#' @param ... additionnal arguments to be passed to lines methods.
+#' @param ... additional arguments to be passed to lines methods.
 #'
 #' @keywords donut
 #'

R/ellipse.R

@@ -20,7 +20,7 @@
 #' @details
 #' For a rotation angle of 0, major radii refer to the one along the x axis.
 #'
-#' The number of cicrles drawn is given by the maximum argument length amng `x`, `y`, `radi`, `from` and `to` arguments.
+#' The number of circles drawn is given by the maximum argument length among `x`, `y`, `radi`, `from` and `to` arguments.
 #' Sizes are adjusted using \code{\link{rep_len}} function.
 #'
 #' To plot ellipses, \code{\link{polygon}} function is called.
@@ -45,9 +45,9 @@
 #' plot0(x=c(-2,2),y=c(-2,2), asp=1)
 #' ellipse(x=c(-1,1),c(1,1,-1,-1),from=pi*seq(0.25,1,by=0.25),to=1.25*pi, col=2, border=4, lwd=3)
 
-ellipse <- function(x = 0, y = x, mjradi = 1, mnradi = 0.5, from = 0, to = 2 * pi, 
+ellipse <- function(x = 0, y = x, mjradi = 1, mnradi = 0.5, from = 0, to = 2 * pi,
     rot = 0, incr = 0.01, pie = FALSE, ...) {
-    
+
     ## --- format checking / adjusting vectors sizes
     matx <- as.matrix(x)
     argn <- c("x", "y", "mjradi", "mnradi", "from", "to")
@@ -57,22 +57,22 @@ ellipse <- function(x = 0, y = x, mjradi = 1, mnradi = 0.5, from = 0, to = 2 * p
     argo <- list(x, y, mjradi, mnradi, from, to)
     sz <- max(sapply(argo, length))
     for (i in 1L:nbarg) assign(argn[i], rep_len(argo[[i]], sz))
-    
+
     ## --- draw the ellipse
     for (i in 1L:sz) {
         ## --- sequence to draw the ellipse
         if (abs(to[i] - from[i]) >= (2 * pi)) {
             to[i] <- 2 * pi
             from[i] <- 0
         } else {
-            if ((to[i] > from[i]) & (to[i]%%(2 * pi) == 0)) 
+            if ((to[i] > from[i]) & (to[i]%%(2 * pi) == 0))
                 to[i] <- 2 * pi
             to[i] <- to[i]%%(2 * pi)
             from[i] <- from[i]%%(2 * pi)
-            if (to[i] < from[i]) 
+            if (to[i] < from[i])
                 to[i] <- to[i] + 2 * pi
         }
-        ## 
+        ##
         sqc <- seq(from[i], to[i], by = incr)
         seqx <- x[i] + mjradi[i] * cos(sqc)
         seqy <- y[i] + mnradi[i] * sin(sqc)
@@ -82,8 +82,8 @@ ellipse <- function(x = 0, y = x, mjradi = 1, mnradi = 0.5, from = 0, to = 2 * p
         }
         rotpt <- graphicsutils::rotation(seqx, seqy, xrot = x[i], yrot = y[i], rot = rot)
         graphics::polygon(rotpt$x, rotpt$y, ...)
-        
+
     }
-    ## 
+    ##
     invisible(NULL)
 }

R/encircle.R

@@ -5,7 +5,7 @@
 #' @param x the x coordinates of a set of points. Alternatively, a
 #'       single argument `x` can be provided.
 #' @param y the y coordinates of a set of points.
-#' @param nb.pt the nuber of points to ge generated around eah coordinates.
+#' @param nb.pt the number of points to be generated around each coordinates.
 #' @param off.set the y coordinates of a set of points.
 #' @param ... further arguments to be passed to \code{[graphics::polygon()]} function.
 #'
@@ -32,11 +32,11 @@ encircle <- function(x, y = NULL, nb.pt = 20, off.set = 1, ...) {
     seqa <- seq(0, 2 * pi, length.out = nb.pt + 1)[-1L]
     seqx <- ofs * cos(seqa)
     seqy <- ofs * sin(seqa)
-    ## 
-    pts <- data.frame(x = rep(cfig$x, each = nb.pt) + rep(seqx, nrow(cfig)), y = rep(cfig$y, 
+    ##
+    pts <- data.frame(x = rep(cfig$x, each = nb.pt) + rep(seqx, nrow(cfig)), y = rep(cfig$y,
         each = nb.pt) + rep(seqy, nrow(cfig)))
     ## compute the convex hull and plot it using user system
     graphics::polygon(toUser(pts[grDevices::chull(pts), ]), ...)
-    ## 
+    ##
     invisible(NULL)
 }

R/envelop.R

@@ -1,14 +1,14 @@
 #' Compute the coordinates of an envelop.
 #'
-#' `envelop` eases the compuation of the polygons described by to set
-#' of y coordinates along the x-axis. Optionnaly, the polygons could be added
+#' `envelop` eases the computation of the polygons described by to set
+#' of y coordinates along the x-axis. Optionally, the polygons could be added
 #' on the current plot.
 #'
 #' @param x vectors containing the x coordinates.
 #' @param upper the y coordinates of the upper values.
 #' @param lower the y coordinates of the lower values.
 #' @param add a logical. If `TRUE` the envelop is drawn as a polygon (default behavior).
-#' @param ... additionnal arguments to be passed to \code{[graphics::polygon()]} function.
+#' @param ... additional arguments to be passed to \code{[graphics::polygon()]} function.
 #'
 #' @export
 #'
@@ -29,7 +29,7 @@ envelop <- function(x, upper, lower = rep(0, length(upper)), add = TRUE, ...) {
     stopifnot(length(x) == length(upper))
     stopifnot(length(x) == length(lower))
     out <- list(x = c(x, rev(x)), y = c(upper, rev(lower)))
-    if (add) 
+    if (add)
         graphics::polygon(c(x, rev(x)), c(upper, rev(lower)), ...)
     invisible(out)
 }

R/gpuPalettes.R

@@ -1,6 +1,6 @@
-#' Complete list of graphisutils' color palettes
+#' Complete list of graphicsutils' color palettes
 #'
-#' Color palettes of the graphisutils package.
+#' Color palettes of the graphicsutils package.
 #'
 #' @export