add pkgdown website

Author: Kevin Cazelles

.Rbuildignore

@@ -13,3 +13,5 @@
 ^inst/tmp
 ^LICENSE
 ^CONDUCT.md
+^_pkgdown\.yml$
+^docs$

DESCRIPTION

@@ -2,7 +2,7 @@ Package: graphicsutils
 Type: Package
 Title: Collection of graphics utilities
 Version: 1.2-0
-Date: 2018-03-18
+Date: 2018-07-27
 Authors@R: c(person("Kevin", "Cazelles", role = c("aut", "cre"), email = "kcazelle@uoguelph.ca", comment = c(ORCID = "0000-0001-6619-9874")),
   person("Nicolas", "Casajus", role = c("aut"), comment = c(ORCID = "0000-0002-5537-5294")),
   person("David", "Beauchesne", role = c("aut")))

R/RcppExports.R

@@ -1,8 +1,7 @@
-# Generated by using Rcpp::compileAttributes() -> do not edit by hand Generator
-# token: 10BE3573-1514-4C36-9D1C-5A225CD40393
+# Generated by using Rcpp::compileAttributes() -> do not edit by hand
+# Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393
 
 pointsInPolygon_core <- function(points, polygon) {
-    .Call("_graphicsutils_pointsInPolygon_core", PACKAGE = "graphicsutils", points, 
-        polygon)
+    .Call('_graphicsutils_pointsInPolygon_core', PACKAGE = 'graphicsutils', points, polygon)
 }
 

R/circles.R

@@ -9,7 +9,7 @@
 #' @param to the angles, expressed in radians, to which circles are drawn.
 #' @param incr increments between two points to be linked (expressed in radians).
 #' @param pie a logical. If \code{TRUE}, end points are linked with the center of the circle (default is set to \code{FALSE}).
-#' @param clockwise a logical. Shall slices be drawn clockwise?
+#' @param clockwise a logical. Shall circles and arcs be drawn clockwise? Defaut is `FALSE`.
 #' @param add a logical. Should the circles be added on the current plot?
 #' @param ... additional arguments to be passed to \code{\link[graphics]{polygon}} function.
 #'
@@ -47,12 +47,12 @@
 #' plot0(x=c(-2,2),y=c(-2,2), asp=1)
 #' circles(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)
 
-circles <- function(x, y = x, radi = 1, from = 0, to = 2*pi, incr = 0.01, pie = FALSE,
+circles <- function(x, y = x, radi = 1, from = 0, to = 2 * pi, incr = 0.01, pie = FALSE, 
     clockwise = FALSE, add = TRUE, ...) {
-    #
-    pipi <- 2*pi
-    #
-    if (!isTRUE(add))
+    # 
+    pipi <- 2 * pi
+    # 
+    if (!isTRUE(add)) 
         plot0()
     # format checking / adjusting vectors sizes
     matx <- as.matrix(x)
@@ -61,6 +61,7 @@ circles <- function(x, y = x, radi = 1, from = 0, to = 2*pi, incr = 0.01, pie =
     nbcol <- min(nbarg, ncol(matx))
     for (i in 1L:nbcol) assign(argn[i], matx[, i])
     argo <- list(x, y, radi, from, to)
+    ## 
     sz <- max(sapply(argo, length))
     for (i in 1L:nbarg) assign(argn[i], rep_len(argo[[i]], sz))
     # drawing circles
@@ -71,27 +72,27 @@ circles <- function(x, y = x, radi = 1, from = 0, to = 2*pi, incr = 0.01, pie =
         ## --- angles sequence
         if (dagl >= pipi) {
             # no point of drawing a circle multiple times
-            to[i] <- pipi
-            from[i] <- 0
+            to[i] <- pipi + 0.5 * pi
+            from[i] <- 0.5 * pi
         }
-        ##
+        ## 
         if (!clockwise) {
-          sqc <- seq(from[i], from[i] + dagl, by = incr)
+            sqc <- seq(from[i], from[i] + dagl, by = incr)
         } else {
-          sqc <- seq(from[i], from[i] -dagl, by = -incr)
+            sqc <- seq(from[i], from[i] - dagl, by = -incr)
         }
-
+        ## 
         if (!pie) {
             xout <- x[i] + radi[i] * cos(sqc)
             yout <- y[i] + radi[i] * sin(sqc)
         } else {
             xout <- x[i] + c(0, radi[i] * cos(sqc), 0)
             yout <- y[i] + c(0, radi[i] * sin(sqc), 0)
         }
-
+        
         graphics::polygon(xout, yout, ...)
         out[[i]] <- data.frame(x = xout, y = yout)
     }
-
+    
     invisible(out)
 }

README.md

@@ -21,6 +21,7 @@ Related with this, is one very helpful article by Paul Murrell: [The
 gridGraphics
 Package](https://journal.r-project.org/archive/2015-1/murrell.pdf).
 
+
 Status
 ------
 
@@ -45,182 +46,10 @@ Then, load it:
 
     library(graphicsutils)
 
-Main features
--------------
-
-### Empty your plot
-
-To start a figure from scratch it is often useful to get a plot without
-nothing but having the correct size of axes. `plot0()` allows the user
-to do so:
-
-    plot0(c(0,1),c(0,1))
-
-![](inst/assets/img/plot0-1.png)
-
-Quite empty, isn’t it? Also, it can be filled with any color using the
-`fill` parameter.
-
-    plot0(c(-10,10), fill='#ebebeb', grid.col = 'white')
-
-![](inst/assets/img/plot0v2-1.png)
-
-And also add a text:
-
-    plot0(c(-10,10), asp=1, fill=8, text='cool', srt=45, cex=4, col=2)
-
-![](inst/assets/img/plot0v3-1.png)
-
-### Add a box
-
-The `box2()` function allows the user to add any axes around the plot in
-a more flexible way.
-
-    par(mar=rep(2,4))
-    plot0()
-    box2(which="figure", lwd=2, fill="grey30")
-    box2(side=12, lwd=2, fill="grey80")
-    axis(1)
-    axis(2)
-
-![](inst/assets/img/box2-1.png)
-
-### Encircle points
-
-    coords <- cbind(runif(10), runif(10))
-    plot0(coords)
-    points(coords, bg="grey25", pch=21)
-    encircle(coords, border="#7b11a1", lwd=2)
-
-![](inst/assets/img/encircle-1.png)
-
-### Add an image
-
-The `pchImage()` function eases the uses of `rasterImage()` to add
-images (including png and jpeg files) on a graph. It allows to change
-the color of the whole image.
-
-    pathLogo <- system.file("img", "Rlogo.png", package="png")
-    par(mar=c(4,1,4,1), mfrow=c(1,2))
-    plot0()
-    pchImage(0, 0, file=pathLogo, cex.x =4.5, cex.y=4)
-    plot0()
-    pchImage(0, 0, file=pathLogo, cex.x =4.5, cex.y=4, col="grey25", angle=25)
-
-![](inst/assets/img/pchImage-1.png)
-
-### A stacked areas chart
-
-#### A simple stacked areas
-
-    plot0(c(0, 10),c(0, 10))
-    sz <- 100
-    seqx <- seq(0, 10, length.out=sz)
-    seqy1 <- 0.2*seqx*runif(sz, 0, 1)
-    seqy2 <- 4+0.25*seqx*runif(sz, 0, 1)
-    seqy3 <- 8+0.25*seqx*runif(sz, 0, 1)
-    envelop(seqx, seqy1, seqy2, col="grey85", border=NA)
-
-![](inst/assets/img/envelop-1.png)
-
-#### A complete stacked areas
 
-    x <- data.frame(matrix(runif(200, 2, 10), 8, 25))
-    stackedAreas(x)
-
-![](inst/assets/img/stackedArea-1.png)
-
-### Polar plot
-
-    polarPlot(1:40, stats::runif(40), to=1.9*pi, col="grey30", border="grey80")
-
-![](inst/assets/img/polarPlot-1.png)
-
-### Get pretty ranges
-
-    vec <- stats::runif(20)
-    range(vec)
-    R>>  [1] 0.05697909 0.95889704
-    prettyRange(vec)
-    R>>  [1] 0.05 1.00
-    prettyRange(c(3.85, 3.88245))
-    R>>  [1] 3.850 3.885
-
-### Interactive functions
-
-Some functions are interactive and fairly understandable! So, I suggest
-you try the following functions:
-
-    pickColors()
-
-    layout2()
-
-### Colors
-
-`darken()` and `lighten()` functions are convenient way to produce
-consistent set of shaded colors with minimal effort; also use
-`showPalette()` to display your palette.
-
-    someblue <- darken("blue", 10*1:9)
-    showPalette(someblue)
-
-![](inst/assets/img/darken-1.png)
-
-    somered <- lighten("red", 10*1:9)
-    showPalette(somered, add_codecolor=TRUE)
-
-![](inst/assets/img/lighten-1.png)
-
-Since version 1.1-2 a set of color palettes has been added, see
-`gpuPalette()`.
-
-    showPalette(gpuPalette("insileco"), add_codecolor=TRUE)
-
-![](inst/assets/img/insileco-1.png)
-
-Image 2
--------
-
-    image2(matrix(1:9, 3))
-
-![](inst/assets/img/image2-1.png)
-
-    image2(matrix(1:27, 3), from=2, border = 2, lwd=2)
-
-![](inst/assets/img/image2-2.png)
-
-Vector fields
+Main features
 -------------
 
-    systLin <- function(X, beta){
-        Y <- matrix(0,ncol=2)
-        Y[1L] <- beta[1,1]*X[1L]+beta[1,2]*X[2L]
-        Y[2L] <- beta[2,1]*X[1L]+beta[2,2]*X[2L]
-        return(Y)
-    }
-    seqx <- seq(-2,2,0.31)
-    seqy <- seq(-2,2,0.31)
-    beta1 <- matrix(c(0,-1,1,0),2)
-    # Plot 1:
-    vecfield2d(coords=expand.grid(seqx, seqy), FUN=systLin, args=list(beta=beta1))
-
-![](inst/assets/img/vectorfields-1.png)
-
-    # # Plot 2:
-    graphics::par(mar=c(2,2,2,2))
-    vecfield2d(coords=expand.grid(seqx, seqy), FUN=systLin,
-       args=list(beta=beta1), cex.x=0.35, cex.arr=0.25,
-       border=NA,cex.hh=1, cex.shr=0.6, col=8)
-    graphics::abline(v=0, h=0)
-
-![](inst/assets/img/vectorfields-2.png)
-
-Compass Rose
-------------
-
-    compassRose(0, rot=25, cex.cr = 2, col.let =2, add = FALSE)
-
-![](inst/assets/img/compassRose-1.png)
 
 Code of Conduct
 ---------------