Package 'graphicsutils'

Description

This function adds cardinal directions to axis labels in a map.

Usage

addAxis(side, at = axTicks(side), mgp = par()$mgp, digits = 0, ...)

Arguments

Author(s)

Nicolas CASAJUS, [email protected]

Examples

maps::map()
addFrame(grid = TRUE, add = TRUE, width = 5)
addAxis(1)
addAxis(2, at = seq(-50, 50, 100), digits = 2)
addAxis(3, lwd = 0, lwd.ticks = 0.5)
addAxis(4, las = 1, col.axis = "red")

Description

This function adds a checkerboard-like frame around an existing plot (or a new one) as an ensemble of small rectangles whose colors, position and width can be specified by user.

Usage

addFrame(
  at_x,
  at_y,
  col = c("white", border),
  border = "black",
  width = NULL,
  lwd = 1,
  lty = 1,
  asp = NA,
  grid = FALSE,
  add = FALSE,
  ...
)

Arguments

Details

If add = FALSE, a new plot is drawn with xlim = ylim = c(-1, 1). Argument col can be set with one or multiple colors. If only one color is specified in col, border color will be used to draw the checkerboard. If width is NULL, the width of the frame is equivalent to 4% of the extent of the plot area.

Author(s)

Nicolas Casajus, [email protected]

Examples

## Grid and graduations
addFrame()
addFrame(grid = TRUE)
addFrame(grid = TRUE, lwd = 0.25, lty = 3)
addFrame(at_x = seq(-1, 1, by = 0.1))

## Frame width
addFrame(width = 0.25)
addFrame(at_x = seq(-1, 1, by = 0.01), width = 1.00)

## Colors
addFrame(col = 1:6)
addFrame(col = "lightgray", border = "darkgray")

## Adding to a plot
maps::map()
addFrame(grid = TRUE, add = TRUE, width = 5)
maps::map.axes()

## Other graphical parameters
addFrame(bg = "darkgray", xaxs = "i", yaxs = "i")

Description

This function adds a grid to an existing plot (like box()). User can specify coordinates on x- and/or y-axis where to draw vertical and/or horizontal lines respectively. User can also color the background of the plot area and add a box around this area (if required).

Usage

addGrid(
  at_x,
  at_y,
  col = NA,
  border = "black",
  lwd = 1,
  lty = 1,
  box = FALSE,
  ...
)

Arguments

Details

If user does not specify at_x and at_y, the grid is aligned with the tick marks on the corresponding default axes (computed by axTicks).

Author(s)

Nicolas CASAJUS, [email protected]

Examples

maps::map()
addGrid()
addGrid(box = TRUE)
addGrid(col = "#ff000044", border = "green", box = TRUE)

maps::map()
addGrid(at_x = axTicks(1), border = "blue", lwd = 2)
addGrid(at_y = axTicks(2), border = "red")
addGrid(at_x = NULL, at_y = NULL, lwd = 3, box = TRUE)

Description

Draw a custom arrows between pairs of points.

Usage

arrows2(
  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,
  ...
)

Arguments

See Also

graphics::arrows()

Examples

# Example 1:
plot0(c(0, 10), c(0, 10))
arrows2(1, 9, 8)
arrows2(1, 8, 8, 1, cex.hh = 1.2, cex.hl = 1.2, col = "grey30", lwd = 1.2,
 prophead = TRUE, twoheaded = TRUE)
arrows2(5, 9, 5, 1)

# Example 2:
plot0(c(0, 1), c(0, 1))
arrows2(runif(2), runif(2), x1 = runif(2), y1 = runif(2))
arrows2(runif(2), runif(2), x1 = runif(2), y1 = runif(2), prophead = FALSE,
 lty = 3)

Description

Draws boxplots and bi-boxplots.

Usage

biBoxplot(
  df1,
  df2 = df1,
  probs = c(0.01, 0.25, 0.5, 0.75, 0.99),
  width = 0.2,
  sta_wd = 0.5,
  median = NULL,
  staples = NULL,
  whiskers = NULL,
  col_left = "grey75",
  col_right = col_left,
  add = FALSE,
  at = NULL
)

Arguments

Details

This functions does not attempt to assess the distributions as it is based on quantiles.

Examples

dis1 <- list(stats::rnorm(1000, sd = 0.25))
biBoxplot(dis1)

Description

Blend a set of colors and return the color thereby obtained.

Usage

blendColors(cols)

Arguments

Examples

blendColors(c("blue", "purple"))

Description

Draw a box around a plot.

Usage

box2(side, which = c("plot", "figure", "outer", "inner"), fill = NULL, ...)

Arguments

Details

This function intends to give more flexibility to the graphics::box() function. As which parameter, the user provides an object first coerced by as.character to a character string that is secondly split into single characters. For all of these characters, matches are sought with all elements of ⁠1, 2, 3, 4, b, l, t, r⁠ where ⁠1=below, 2=left, 3=above, 4=right, b=below, l=left, t=above and r=right⁠.

See Also

graphics::box()

Examples

# Example 1:
plot0()
box2()

# Example 2:
plot0()
box2("14", fill = "grey80", lwd = 2)
plot0()
box2(c(1, 4), fill = "grey80", lwd = 2)
plot0()
box2(c(1, 4), fill = "grey80", lwd = 2)

# Example 3:
par(mfrow = c(2, 2), oma = c(2, 2, 2, 2))
plot0(0, 0)
box("outer", lwd = 2)
box("inner", lwd = 2)
plot.default(0, 0)
plot.default(0, 0)
plot0()
box2(which = "figure", lwd = 2, fill = 2)
box2(side = 12, lwd = 2, fill = 8)

Description

Produce custom box-and-whisker plot(s) of the given (grouped) values.

Usage

boxplot2(
  x,
  ...,
  probs = c(0.05, 0.25, 0.5, 0.75, 0.95),
  vc_cex = c(5, 18, 1.4),
  colors = c("grey75", "grey75", "grey20"),
  med_pch = 3,
  add = FALSE,
  at = NULL
)

Arguments

Value

Draw a boxplot and returns the coordinates as an invisible output.

Author(s)

Kevin Cazelles

Examples

boxplot2(replicate(10, runif(100)))
dfa <- data.frame(name = rep(LETTERS[1:4], 25), val = runif(100))
plot0(c(0, 5), c(0, 1))
boxplot2(val ~ name, data = dfa, add = TRUE, vc_cex = c(4, 40, 2))

Description

Draw circles in a flexible way.

Usage

circles(
  x,
  y = x,
  radi = 1,
  from = 0,
  to = 2 * pi,
  incr = 0.01,
  pie = FALSE,
  clockwise = FALSE,
  add = TRUE,
  ...
)

Arguments

Details

The number of circles drawn is given by the maximum argument length amng x, y, radi, from and to arguments. Sizes are adjusted (i.e. repeated over) with rep_len() function.

Value

An invisible list of data.frame of two columns including the coordinates of all circles.

See Also

graphics::symbols(), plotrix::draw.circle(), plotrix::draw.arc().

Examples

# Example 1:
plot0()
circles(x = 0)

# Example 2:
plot0()
circles(x = -.5, radi = 0.45, from = 0.5 * pi, to = 0.25 * pi)
circles(x = .5, radi = 0.45, from = 0.5 * pi, to = 0.25 * pi, pie = TRUE)
circles(x = .5, y = -.5, radi = 0.45, from = 0.5 * pi, to = 0.25 * pi, pie
= TRUE, clockwise = TRUE)

# Example 3:
plot0()
circles(matrix(-.5 + .5 * stats::runif(18), ncol = 3))

# Example 4:
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)

Description

Simple and flexible color scale.

Usage

colorScale(
  x,
  y,
  col,
  at = NULL,
  labels = NULL,
  horiz = TRUE,
  percx = NULL,
  percy = NULL,
  adj = 0,
  labels.cex = 1,
  title = "legend",
  title.cex = 1.2
)

Arguments

Examples

plot(c(0, 10), c(0, 10))
colorScale(5, 5, gpuPalette("cisl", 10), at = c(2, 4))

Description

This function draws a fully personnalisable compass rose.

Usage

compassRose(
  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,
  ...
)

compassRoseCardinal(
  x,
  y = x,
  rot = 0,
  cex.cr = 1,
  cex.let = 1,
  labels = c("S", "W", "N", "E"),
  offset = 1.2,
  col.cr = c(1, 8),
  col.let = 1,
  border = c(1, 8),
  ...
)

Arguments

Details

Both col.cr and border are repeated over (base::rep() is called) so it has a 8 elements, meaning all triangles the compass rose is made of could have their own color.

Note that there already exists a similar function by Jim Lemon in sp package.

Functions

• compassRose(): A compass rose with the four cardinal directions and additional directions.

• compassRoseCardinal(): A compass with the four cardinal directions only.

Examples

compassRose(0, rot = 25, cex.cr = 2, col.let = 2, add = FALSE)

Description

For a given set of colors, contrastColors returns an associated set of colors.

Usage

contrastColors(colors, how = "how_borw", alpha = FALSE)

col2Hex(colors, alpha = FALSE)

Arguments

Details

Based on the sum of colors' saturation how_borw returns black or white, how_prop proportionally remove or add some saturation. how_oppo opposes the color (255-x) and how_cent centers the columns, i.e. remove or add 127.

Functions

• contrastColors(): Retuns a set of colors contrasted.

• col2Hex(): Returns the hexadecimal string associates to a given vector of colors.

See Also

grDevices::col2rgb()

Examples

contrastColors("blue")
contrastColors("blue", how = "how_prop")

Description

A data frame to showcase ganttChart().

Usage

data(dfGantt)

Format

A simulated data frame to create a Gantt chart.

Author(s)

David Beauchesne

Description

Draw a donut chart.

Usage

donut(
  vec,
  eaten = 0,
  labels = NULL,
  rot = 0,
  cex = 0.8,
  tck = 0.05,
  width = 0.6,
  mycol = 1 + seq_along(vec),
  density = NULL,
  angle = 45,
  dt = 0.001,
  add = FALSE,
  cx = 0,
  cy = 0,
  border = NA,
  clockwise = TRUE,
  ...
)

Arguments

Details

As pie chart, donut charts are a very bad way of displaying information, see graphics::pie() The aspect of the donut is fully customizable. If width is set to 1 and eaten to 0, the donut chart is then a pie chart.

Note

Substantial part of the code have been inspired by the pie function.

The 'col' argument determines the succession of colors to be applied to each axis.

Examples

# Example 1:
graphics::par(mfrow = c(2, 2), mar = rep(2, 4))
donut(vec = c(10, 20, 15))
donut(c(10, 20, 15), eaten = 0.2)
donut(c(10, 20, 15), eaten = 0.2, rot = 180, labels = paste("group", 1:3), lwd = 3, col = 8)
donut(c(10, 20, 15), 0.2, cx = 4, col = 4, mycol = c(4, 3, 2), density = 30, angle = c(20, 55, 110))

# Example 2:
plot0(c(0, 10), c(0, 40), type = "n")
vec <- runif(7)
donut(vec, 0.15, cx = 5, cy = 20, add = TRUE, col = 2)

Description

Draw ellipses in a flexible way.

Usage

ellipse(
  x = 0,
  y = x,
  mjradi = 1,
  mnradi = 0.5,
  from = 0,
  to = 2 * pi,
  rot = 0,
  incr = 0.01,
  pie = FALSE,
  ...
)

Arguments

Details

For a rotation angle of 0, major radii refer to the one along the x axis. The number of circles drawn is given by the maximum argument length among x, y, radi, from and to arguments. Note vector length are adjusted using rep_len().

Note

There is a similar function, called draw.ellipse, in the package plotrix.

Examples

# Example 1:
plot0(asp = 1)
ellipse()

# Example 2:
plot0()
for (i in seq(0, 360, 30)) ellipse(rot = i)

# Example 3:
plot0()
ellipse(matrix(-.5 + .5 * stats::runif(18), ncol = 3))

# Example 4:
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
)

Description

Draw a polygons around a certains set of points.

Usage

encircle(x, y = NULL, nb.pt = 20, off.set = 1, ...)

Arguments

Details

The technique employed is straightforward: for each point, a circle of radius of off.set⁠made of⁠nb.pt' points, then a convex is drawn around the coordinates using grDevices::chull().

Examples

coords <- cbind(runif(10), runif(10))
plot0(coords)
points(coords, bg='grey25', pch=21)
encircle(coords, border='#7b11a1', lwd=2)

Description

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.

Usage

envelop(x, upper, lower = rep(0, length(upper)), add = TRUE, ...)

Arguments

Value

The coordinates of the envelop are returned if assigned.

Examples

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)
envelop(seqx, seqy2, seqy3, col = 'grey25', border = NA)

Description

Draw a frame around the plot region as an ensemble of small rectangles whose colors can be specified.

Usage

frameIt(
  nbc = 10,
  cex.x = 1,
  cex.y = cex.x,
  col = c("grey45", "grey85"),
  border = NA
)

Arguments

Details

The number of rectangles could be different from nbc as pretty is called to properly locate them. The col argument determines the succession of colors to be applied to each axis.

Examples

# Example 1:
plot0()
frameIt()

# Example 2:
plot0()
frameIt(cex.x = 1.5, col = c(2, 3), border = 1)

Description

A flexible Gantt Chart.

Usage

ganttChart(
  df,
  task_order = TRUE,
  mstone_add = task_order,
  mstone_spacing = 1,
  mstone_lwd = 2,
  axes = TRUE,
  mstone_font = 2,
  lighten_done = 0
)

Arguments

Details

Argument df should be a data frame with the following columns (in any order):

• milestone: milestones names,

• due: due date (will be converted into a date with as.Date()),

• start: start date (will be converted into a date with as.Date()),

• task: tasks names. It might as well include any of the following optional columns:

• done: vector of logicals indicating whether the task if completed

• col: to custom the color of the tasks.

Author(s)

David Beauchesne, Kevin Cazelles

References

https://insileco.github.io/2017/09/20/gantt-charts-in-r/

Examples

ff <- ganttChart(dfGantt,
  mstone_lwd = 3, mstone_spacing = 0.6,
  lighten_done = 80
)

Description

Calcul the angles of two set of vectors.

Usage

getAngle2d(x0, y0, x1, y1, rad = FALSE)

Arguments

Examples

# Example:
plot0(c(-10, 10), c(-10, 10))
arrows(c(0, 3), c(0, 0), c(3, 0), c(3, -3))
cool <- getAngle2d(c(0, 3), c(0, 0), c(3, 0), c(3, -3))

Description

A couple of color palettes including our inSileco palette and a couple of other inspired by popular websites.

Usage

gpuPalette(id, ncolors)

Arguments

Value

A vector of character strings of the hexadecimal colors values. Note that if several color palette is requested, then the output is a vector with all color palette concatenated.

Examples

showPalette(gpuPalette(c('atom', 'cisl')))
showPalette(gpuPalette('cisl', 100))

Description

Color palettes of the graphicsutils package.

Usage

gpuPalettes

Format

An object of class list of length 7.

Description

A collection of (hopefully) useful functions to create graphics based plots.

Description

Compute a homothetic transformation for a set of points. The transformed set of points is optionally drawn as a polygon.

Usage

homothety(x, y, lambda, xcen = NULL, ycen = NULL, add = FALSE, ...)

Arguments

Details

If x is a matrix with more than 2 columns, then x is the first column and y the second one.

Note that lambda, xcen and ycen are unique, meaning that homothety computes only one homothetic transformation. Drawing the points computed is relevant only if there are more than 2 points.

References

https://en.wikipedia.org/wiki/Homothetic_transformation.

Examples

# Example:
plot0(c(0, 10), c(0, 10))
x <- c(4, 6, 5)
y <- c(2, 2, 4)
polygon(x, y)
poly2 <- homothety(x, y, 2)
polygon(poly2$x, poly2$y)
poly3 <- homothety(x, y, -2.5, xcen = 5, ycen = 4, border = 4, add = TRUE)

Description

Compute the number of rows and columns to split a graphic window into panels as equally as possible.

Usage

howManyRC(n)

Arguments

Value

A vector of two elements: the number of rows followed by the number of columns.

Description

Creates a grid of colored or gray-scale rectangles. This function is similar to graphics::image() when used for a matrix but simpler (i.e less available features).

Usage

image2(
  x,
  from = NULL,
  to = NULL,
  color_scale = NULL,
  border = NA,
  add_value = FALSE,
  val_cex = 1,
  n_signif = 2,
  ...
)

Arguments

Details

This function actually draws rectangles to create an image from a matrix. Unlike graphics::image(), image2 the image is ordered just as the matrix is displayed meaning that the cell (1,1) is at the upper left cell of the plot drawn. Note that currently neither titles nor axes' labels are added user should call the graphics::title() and graphics::axis(). Concerning the latter, the user should be aware that cell's coordinates range from 0 to 1 with 0 being the coordinates of the first cell and 1 the coordinates of the last cell (if there is only one cell then the center of the unique cell is 0).

See Also

graphics::image() graphics::rect()

Examples

image2(matrix(1:9, 3))
image2(matrix(1:9, 3), add_value = TRUE)
image2(matrix(1:27, 3), from=2, border = 2, lwd=2)

Description

layout2() provides an interactive version of graphics::layout(). Once called, an interactive grid is displayed and can be used to create a layout.

Usage

interactiveLayout(
  n = 1,
  grain.x = 20,
  grain.y = grain.x,
  show = TRUE,
  now = TRUE
)

Arguments

Details

Arguments grain.x and grain.y control the aspect of the support grid generated to locate the different panels. Once the grid pops up, the user must click 2n times to select the size of the n subplots. A panel is delimited by two consecutive clicks, the tow cells selected by click 2p and clicks 2*p+1 will be used to compute the area allocated to panel p. Note that the user is allowed to use the same area for several plots but only this area will actually be used only by the last one.

As graphics::layout() is ultimately called, layout2() has the same limits, i.e. currently 200 for the numbers of rows and columns and 10007 for the total number of cells.

Value

the matrix use to draw the layout is returned as an invisible output.

Description

pchimage returns a plot that displays an image. It allows users to directly include a .png or a .jpeg file in a plot region.

Usage

pchImage(
  x,
  y,
  obj = NULL,
  file = NULL,
  cex.x = 1,
  cex.y = cex.x,
  atcenter = TRUE,
  add = TRUE,
  col = NULL,
  ...
)

Arguments

Details

Either obj or file must be defined. If file is not null, then png::readPNG() or jpeg::readJPEG() according to the end of the file extension.

Examples

# Example:
img <- png::readPNG(system.file('img', 'Rlogo.png', package='png'), native=TRUE)
n<-15
plot0(c(0,1),c(0,1))
pchImage(0.1+0.8*stats::runif(n), 0.1+0.8*stats::runif(n), cex.x=0.2+1.6*stats::runif(n),
obj=img, angle=360*runif(n), col=2)

Description

Returns the values of either x-axis or y-axis for a given percentage.

Usage

percX(percentage = 90)

percY(percentage = 90)

Arguments

Details

This function intends to ease the positioning of additional marks on plot (such as annotation). Note that percentages refer to the entire plot window.

Functions

• percX(): Returns the values of x-axis for a given percentage.

• percY(): Returns the values of y-axis for a given percentage.

Examples

plot0()
text(x = percX(90), y = percY(90), label = "cool")

Description

Generate an interactive interface to pick a set of colors up.

Usage

pickColors(n = 9, ramp = grDevices::rainbow(1024), nb_shades = 512)

Arguments

Details

This function generates a graphical window split into 6 panels. The top panel serves to select one tone. The panel right below presents nb_shades of the selected tones. The bottom right panel displays the current selection that can be stored by clicking on the bottom left panel Keep it. The bottom center panel shows the characteristic of the selected color. Finally, in order to abort before completing the selection of colors, the user can simply click on the Stop panel (on the left).

Value

A character vector including the colors selected.

Description

plot0 returns an a plot of a specific size without any symbols.

Usage

plot0(
  x = c(-1, 1),
  y = NULL,
  fill = NULL,
  text = NULL,
  grid.col = NULL,
  grid.lwd = 1,
  grid.lty = 1,
  ...
)

Arguments

Examples

# Example 1
plot0()

# Example 2
plot0(c(-10,10), asp=1)

# Example 3
plot0(c(-10,10), text='cool', cex = 2)

# Example 3
plot0(c(-10,10), asp=1, fill=8, text='cool', srt=45, cex=4, col=2)

# Example 4
plot0(c(-10,10), fill='#ebebeb', grid.col = 'white')

# Example 4
plot0(c(-10,10), grid.col = 2)

Description

Color the plot area by drawing a rectangle. Default color is 'grey80'.

Usage

plotAreaColor(color = "grey80", border = NA, ...)

Arguments

Details

The function calls graphics::rect() and draw a colored rectangle (default color is set to light blue) whose dimensions are given by argument usr of function graphics::par().

Note

In graphics::par(), argument bg colors the entire window.

Examples

#Example 1:
plot0()
plotAreaColor()

#Example 2:
plot0()
plotAreaColor(col=8, lwd=4, border=4)

Description

Returns a plot that displays an image. It enables users to directly include a .png or a .jpeg file in a plot region by providing their path.

Usage

plotImage(obj = NULL, file = NULL, add = FALSE, ...)

Arguments

Details

Note that either obj or file must be defined. If a path is provided either readPNG or readJPEG according to the end of the file extension.

Examples

img <- png::readPNG(system.file('img', 'Rlogo.png', package='png'),
native=TRUE)
op <- par(no.readonly = TRUE)
par(mfrow=c(4,4), mar=rep(2,4))
for (i in seq_len(16)) plotImage(img)
par(op)

Description

Plots a set of means computed based on a dataset and draw error associated.

Usage

plotMeans(
  formula,
  data,
  FUN_err = stats::sd,
  add = FALSE,
  seqx = NULL,
  draw_axis = TRUE,
  col_err = par()$col,
  col_pt = par()$col,
  cex_pt = 1,
  connect = FALSE,
  args_con = list(),
  ...
)

Arguments

Examples

# Example:
dataset <- data.frame(dat = c(rnorm(50, 10, 2), rnorm(50, 20, 2)), 
 grp = rep(c("A", "D"), each = 50))
graphics::par(mfrow = c(1, 3))
plotMeans(dat ~ grp, data = dataset, pch = 19)
#
plotMeans(dat ~ grp,
    data = dataset, FUN_err = function(x) sd(x) * 2, pch = 15,
    ylim = c(-5, 30), yaxs = "i", connect = TRUE,
    args_con = list(lwd = 2, lty = 2, col = "grey35")
)
#
ser <- function(x) sd(x) / sqrt(length(x))
plot0(c(0, 4), c(0, 30))
plotMeans(dat ~ grp,
    data = dataset, FUN_err = ser, pch = 15,
    draw_axis = FALSE, add = TRUE, seqx = c(.5, 3.5), mar = c(6, 6, 1, 1),
    cex = 1.4
)
graphics::axis(2)

Description

plotOnSide adds plot areas on the specified sides of the original figures.

Usage

plotOnSide(mat, side = 1:2, dim = NULL, quiet = FALSE, ...)

Arguments

Details

This function eases the creation of plots that include multiple panels that shares information such as axis labels. Instead of repeating or deleting axis labels, plotOnSide add plot areas on the specified sides of the original figures. It is based on graphics::layout() and it is no more than a tuned version of it.

Examples

plotOnSide(matrix(1, 2), width = c(0.2, 1), height = c(1, 1, 1, 0.6))
graphics::layout.show(5)

Description

For a given matrix of points coordinates, pointsInPolygon returns a logical vector stating whether or not these points are inside a specific polygon whose coordinate as passed as an argument.

Usage

pointsInPolygon(points, polygon)

Arguments

Details

Implements the Ray-casting algorithm.

References

https://rosettacode.org/wiki/Ray-casting_algorithm#C

Examples

mat <- matrix(10*runif(100), 50)
res <- pointsInPolygon(mat, cbind(c(4,8,8,4),c(4,4,8,8)))
# Visual assessment
plot0(c(0,10), c(0,10))
polygon(c(4,8,8,4),c(4,4,8,8))
graphics::points(mat[,1], mat[,2], col=res+1)

Description

Draws a polar plot.

Usage

polarPlot(
  seqtime,
  seqval = NULL,
  rad = 1,
  from = 0,
  to = 2 * pi,
  incr = 0.005,
  labelc = NULL,
  tckcol = 1,
  atc = NULL,
  labelr = NULL,
  atr = NULL,
  clockwise = TRUE,
  n_signif = 2,
  add = FALSE,
  ...
)

Arguments

Details

Polar Plot

See Also

polar.plot

Examples

polarPlot(1:40, stats::runif(40), to = 1.9 * pi, col = "grey30", border = "grey80")

Description

This function returns a pretty range of values for a given a vector of type numeric.

Usage

prettyRange(x)

Arguments

Details

This function intends to generate range with round values.

Value

A vector of two values specifying the pretty the range of values.

See Also

base::pretty()

Examples

# Example 1:
vec <- stats::runif(20)
range(vec)
prettyRange(vec)
# Example 2:
prettyRange(c(3.849,3.88245))

Description

Returns lightened or darkened colors, vectorised over percentage. ramp is valid for any couple of colors. Functions darken() and lighten() call ramp to respectively darken and lighten a given color.

Usage

ramp(fromcol, tocol, percentage = 50, as_rgb = FALSE)

darken(col, percentage = 50, as_rgb = FALSE)

lighten(col, percentage = 50, as_rgb = FALSE)

Arguments

Functions

• ramp(): Returns a shaded color.

• darken(): Darken a color.

• lighten(): Lighten a color.

See Also

grDevices::colorRampPalette()

Examples

showPalette(ramp("blue", "red", 10 * 3:7))
darken("red", 50)
more_reds <- lighten("red", seq(10, 90, 9))
showPalette(more_reds)

Description

Add rhombi on a plot and returns areas.

Usage

rhombi(x, y = x, ldg = 1, sdg = ldg, rot = 0, add = FALSE, ...)

Arguments

Details

The number of rhombus maximal is provided by the length of the largest argument among x, y, ldg, sdg and rot. Other arguments are repeated with the largest length as the desired one (see rep_len()). Additional arguments remain the same for every rhombus.

Value

A vector including rhombi areas is returned if assigned.

Examples

# Example 1:
plot0(asp = 1)
rhombi(0)

# Example 2:
plot0(c(-0.4, 1.4), c(-0.4, 1.4))
rhombi(runif(6), runif(5), runif(2), runif(3))

# Example 3:
plot0(asp = 1)
rhombi(x = 0, rot = seq(0, 180, 20), col = 2, border = NA)
rhombi(x = 0, rot = seq(0, 180, 30), ldg = 0.5, col = 7, border = NA)

Description

Rotates a set of points.

Usage

rotation(x, y, rot = 90, xrot = mean(x), yrot = mean(y), rad = FALSE)

Arguments

Details

Returns the coordinates of the points after rotation. If the coordinates of the rotation center are not specified, then the rotation center is the centroid of the points to be rotated.

Examples

plot0(c(0, 10), c(0, 10))
y <- c(6, 6, 9)
x <- c(2, 5, 3.5)
polygon(x, y, lwd = 2)
myrot <- rotation(x, y, rot = 90)
polygon(myrot$x, myrot$y, lwd = 2, border = 4)
myrot2 <- rotation(x, y, rot = -40, 0, 0)
polygon(myrot2$x, myrot2$y, lwd = 2, border = 3)

Description

This function shadows a text and adds it to an existing plot.

Usage

shadowText(x, y, labels, col = "white", bg = par()$fg, radius = 0.1, ...)

Arguments

Author(s)

Nicolas CASAJUS, [email protected]

Examples

plot(1, type = "n", ann = FALSE, las = 1)
shadowText(x = 0.7, y = 1.3, labels = "This is a\nshadow text")
shadowText(x = 1.0, y = 1.3, labels = "This is a\nshadow text",
           family = "serif")
shadowText(x = 1.3, y = 1.3, labels = "This is a\nshadow text",
           family = "mono")
shadowText(x = 1.0, y = 1.0, labels = "This is a shadow text",
           family = "serif", cex = 3, col = "yellow", bg = "red")
shadowText(x = 0.7, y = 0.7, labels = "This is a\nshadow text",
           family = "serif", srt = 45)
shadowText(x = 1.0, y = 0.7, labels = "This is a\nshadow text",
           family = "serif", srt = 180)
shadowText(x = 1.3, y = 0.7, labels = "This is a\nshadow text",
           family = "serif", srt = -45)

Description

Displays a color palette and color details.

Usage

showPalette(
  x = palette(),
  inline = FALSE,
  add_number = TRUE,
  add_codecolor = TRUE,
  cex_num = 1.2
)

Arguments

Value

The color palette displayed as an invisible output.

Examples

showPalette()
showPalette(inline = TRUE)
showPalette(1)
showPalette(sample(1:100, 16), add_number = FALSE, add_codecolor = FALSE)

Description

Draw a stacked areas chart.

Usage

stackedAreas(
  val,
  index = NULL,
  rgy = 1,
  cumul = FALSE,
  transp = FALSE,
  legend = NULL,
  add = FALSE,
  col = NULL,
  pickcolors = FALSE,
  lty = 1,
  lwd = 1,
  border = NA,
  main = "",
  xlab = "",
  ylab = ""
)

Arguments

Details

Areas are drawn using graphics::polygon() and users can take advantage of it to customize their stacked areas (using lwd, lty or border arguments).

Note

The default colors have been inspired by four palettes found on line: http:www.color-hex.com/color-palettes/. plotrix::stackpoly() function from the plotrix package offers a good alternative.

Using a stacked areas chart with more than 20 areas should provide a figure really hard to read.

Examples

# data for 8 populations at 25 different periods.
x <- data.frame(matrix(runif(200,2,10), 8, 25))

# plot 1: default plot
stackedAreas(x)

# plot 2: personalized plot
graphics::par(xaxs = 'i', yaxs = 'i', font = 2, cex.axis = 1.2,
cex.lab = 1.4, bty = 'l')
graphics::plot.default(c(1999, 2027), c(-10, 110), type = 'n',
xlab = 'Years', ylab = 'Percentage',
main = 'My customized stacked areas chart')
plotAreaColor(col = '#f2c4c4')
stackedAreas(x, index = 2001:2025, rgy = 100, lwd = 2, add = TRUE,
border = 'transparent')

Description

This function adds a box around a text in an existing plot. It works differently from the plotrix::textbox() by giving more control to user (no automatic string cesure).

Usage

textBox(
  x,
  y,
  labels,
  align = "c",
  padding = 0,
  cex = 1,
  font = 1,
  col = par("fg"),
  family = par("family"),
  lheight = 1,
  fill = NA,
  border = par("fg"),
  density = NULL,
  angle = 45,
  lwd = par("lwd"),
  lty = par("lty")
)

Arguments

Details

The xy coordinates correspond to the center of the box. If left and right paddings are identical (padding[2] == padding[4]) and text is centered (align = 'c'), then the text is also centered on these coordinates.

padding may be a vector of 1, 2, or 4 values, corresponding to adjustment of all box borders (1 value), top/bottom and left/right borders (2 values), or bottom/left/top/right borders (4 values). A positive value adds space between box border and text, and a negative value removes space between box border and text.

lheight defines the vertical inter-line spacing in a multi-line string. If lheight = 1 (default), no inter-line spacing is added (i.e. each line string is displayed one under the other without space). If lheight = 2, a vertical space corresponding to one string height is added between lines. If lheight = 0, all line strings will be overlapping.

Only the three font families ('sans', 'serif' and 'mono') for family are implemented (no Hershey fonts available).

Other arguments have the same behavior as in the rect() (fill is the equivalent of col()) and text() functions.

Value

A list of length 4 with:

• box, the coordinates of the box (xleft, ybottom, xright, and ytop respectively);

• labels, the strings on each line (length of 1 if no ⁠\n⁠ is the original string);

• x, the coordinates on the x-axis of the center of each strings (length of 1 if no ⁠\n⁠ is the original string);

• y, the coordinates on the y-axis of the center of each strings (length of 1 if no ⁠\n⁠ is the original string).

With these coordinates, user can draw the box and the text by himself (only if same parameters are used, e.g. cex, family, lheight, and font).

Author(s)

Nicolas Casajus, [email protected]

Examples

## Setting the scene ----
plot(1, type = "n", ann = FALSE, las = 1)
coords <- textBox(x = 1, y = 1, labels = "AqA")
str(coords)

rect(coords$box[1], coords$box[2], coords$box[3], coords$box[4], border = 3)
text(x = coords$x, y = coords$y, labels = coords$labels, col = "red")

## Padding ----
plot(1, type = "n", ann = FALSE, las = 1)
textBox(x = 1, y = 1.2, labels = "Hello World (1)",
                   padding = 0.05) # all borders
textBox(x = 1, y = 1.0, labels = "Hello World (2)",
                   padding = c(0.05, 0.20)) # bottom/top and left/right
textBox(x = 1, y = 0.8, labels = "Hello World (3)",
                   padding = c(0.05, 0.05, 0.05, 0.35)) # bottom, left, top, right

## Colors ----
plot(1, type = "n", ann = FALSE, las = 1)
textBox(x = 1, y = 1.2, labels = "Hello World (1)",
                   padding = 0.05, col = "yellow", border = "green",
                   fill = "red")

## Box Types ----
textBox(x = 1, y = 1.0, labels = "Hello World (2)",
                   padding = 0.05, lwd = 3, lty = 3)
textBox(x = 1, y = 0.8, labels = "Hello World (3)",
                   padding = 0.05, density = 30, angle = 45, fill = "gray")

## Text Fonts ----
plot(1, type = "n", ann = FALSE, las = 1)
textBox(x = 1, y = 1.2, labels = "Hello World (1)",
                   padding = 0.05, family = "mono")
textBox(x = 1, y = 1.0, labels = "Hello World (2)",
                   padding = 0.05, family = "serif")
textBox(x = 1, y = 0.8, labels = "Hello World (3)",
                   padding = 0.05, family = "serif", font = 3, cex = 3)

## Text Alignment ----
texte <- "Hello World!\nHow beautiful you are!"
plot(1, type = "n", ann = FALSE, las = 1)
textBox(x = 1, y = 1.2, labels = texte, padding = 0.05,
                   align = "l")
textBox(x = 1, y = 1.0, labels = texte, padding = 0.05,
                   align = "c")
textBox(x = 1, y = 0.8, labels = texte, padding = 0.05,
                   align = "r")

plot(1, type = "n", ann = FALSE, las = 1)
textBox(x = 1, y = 1.2, labels = texte, padding = 0.05,
                   align = "l", lheight = 0)
textBox(x = 1, y = 1.0, labels = texte, padding = 0.05,
                   align = "l", lheight = 1)
textBox(x = 1, y = 0.8, labels = texte, padding = 0.05,
                   align = "l", lheight = 2)

plot(1, type = "n", ann = FALSE, las = 1)
textBox(x = 1, y = 1.2, labels = texte, align = "l",
                   padding = c(0.05, 0.05, 0.05, 0.35))
textBox(x = 1, y = 1.0, labels = texte, align = "c",
                   padding = c(0.05, 0.05, 0.05, 0.35))
textBox(x = 1, y = 0.8, labels = texte, align = "r",
                   padding = c(0.05, 0.05, 0.05, 0.35))

## Removing Box and/or Text ----
plot(1, type = "n", ann = FALSE, las = 1)
textBox(x = 1, y = 1.2, labels = texte, col = "transparent")
textBox(x = 1, y = 1.0, labels = texte, lwd = 0)
textBox(x = 1, y = 0.8, labels = texte, lwd = 0,
                   col = "transparent")

Description

Convert user coordinates to figure region coordinates and conversely.

Usage

toFig(x, y = NULL)

toUser(x, y = NULL)

Arguments

Details

These functions can be used anytime, however, there are useful only once graphics::plot.new() has been called.

Functions

• toFig(): Convert figure region coordinates into user coordinates.

• toUser(): Convert user coordinates into figure region coordinates.

Description

Compute a translation for a set of points. The transformed set of points is optionally add to the current plot.

Usage

translation(x, y, xtrans = 0, ytrans = 0, add = FALSE, ...)

Arguments

Details

For details about what is a translation, see https://en.wikipedia.org/wiki/Translation_(geometry). Note that if x is a matrix with more than 2 columns, then x is the first column and y the second one.

Examples

# Example 1:
plot0(c(0,10),c(0,10))
x <- c(4,6,5)
y <- c(2,2,4)
polygon(x,y)
trans1 <- translation(x,y,xtrans=2,ytrans=5, add=TRUE, border=4, lwd=2)

# Example 2:
x <- c(2,4,3,1)
y <- c(1,1,3,3)
plot0(c(0,10),c(0,10))
polygon(x,y)
for (i in seq_len(6)) translation(x,y,xtrans=i,ytrans=i, add=TRUE,
border=i+1, lwd=2)

Description

Draw a vector field associated to a system of at least two ODE.

Usage

vecfield2d(
  coords,
  FUN,
  args = NULL,
  ndim = NULL,
  slices = c(1, 2),
  fixed = NULL,
  cex.x = 0.25,
  cex.y = cex.x,
  log = FALSE,
  add = FALSE,
  ...
)

Arguments

Details

The FUN function must be a function of at least two arguments. The first argument must contain the dynamical variables as a vector and the second arguments must contain all the other parameters that shapes the dynamical system. When some dimensions are missing, the order of fixed is the one in FUN once the drawn dimension are withdrawn.

Examples

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))
# 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)