Create an Rcss style object

Description

Creates a style sheet object using definition specified in an Rcss file. When a file is not specified, creates a base object object without any styling.

Usage

Rcss(file = NULL, text = NULL)

Arguments

Details

See also related functions RcssGetDefaultStyle() and RcssOverload().

Value

Rcss object

Examples

# define a custom style
custom.style <- Rcss(text="plot { pch:19; col: 2 }")

# display the custom style
printRcss(custom.style, "plot")

# use the custom style in a chart
plot(1:4, 1:4, Rcss=custom.style)

Modify an Rcss style sheet object

Description

Creates a new Rcss style sheet object from the input, modifying one or more properties.

Usage

RcssChange(
  selector,
  propertylist = NULL,
  property = NULL,
  value = NULL,
  Rcssclass = NULL,
  Rcss = "default"
)

Arguments

Value

always returns an Rcss object. Note: when changing the default style, this will return a new style without actually affecting the default style. To change how the default works in practice, assign this return value to RcssDefaultStyle

Examples

style1 <- Rcss(text="points { cex: 1; pch: 19; }")
printRcss("points", Rcss=style1, verbose=TRUE)
style2 <- RcssChange("points", list(cex=2), Rcss=style1)
printRcss("points", Rcss=style2, verbose=TRUE)

Modify an Rcss style sheet object

Description

Creates a new Rcss style sheet object from the input, modifying one or more properties.

Usage

RcssChangePropertyValue(
  Rcss,
  selector,
  Rcssclass = NULL,
  propertylist = NULL,
  property = NULL,
  value = NULL
)

Arguments

Details

Equivallent to RcssChange: use RcssChange instead

Examples

# use RcssChange instead

Vector holding set a compulsory Rcssclass

Description

These style class (or classes) are applied in all functions of the Rcss family.

Usage

RcssCompulsoryClass

Format

An object of class NULL of length 0.

Default Rcssplot style sheet

Description

This style sheet will be applied in all functions of the Rcss family.

Usage

RcssDefaultStyle

Format

An object of class NULL of length 0.

Get current state of compulsory Rcssclass

Description

Fetches the value of the RcssCompulsoryClass object defined in parent environments.

Usage

RcssGetCompulsoryClass(Rcssclass = NULL)

Arguments

Examples

# retrieve the current compulsory class
class.null <- RcssGetCompulsoryClass()

# augment the current compulsory class with more labels
class.A <- RcssGetCompulsoryClass("A")
class.A
class.B <- RcssGetCompulsoryClass("B")
class.B

# when the object RcssCompulsoryClass is set, this augments a vector
RcssCompulsoryClass <- c("X", "Y")
class.XYZ <- RcssGetCompulsoryClass("Z")
class.XYZ

Get default Rcssplot style object

Description

Fetches the value of the RcssDefaultStyle object defined in parent environments.

Usage

RcssGetDefaultStyle(Rcss = "default")

Arguments

Examples

# retrieve the current default style
style.now <- RcssGetDefaultStyle()

Extract a value for an Rcss property

Description

Extract a value for a property from an Rcss style sheet object. Returns a list with two items. "Defined" is a boolean that indicates the property is defined in the style sheet. "Value" gives the actual value of the property.

Usage

RcssGetPropertyValue(Rcss, selector, property, Rcssclass = NULL)

Arguments

Details

Equivalent to RcssProperty; use RcssProperty instead.

Examples

# use RcssProperty or RcssValue instead

Extract a value for an Rcss property

Description

If the requested property is defined within an Rcss object, this function will return the associated value. If the property is not defined, the function returns a default value that can be passed into the function and is set NULL otherwise. See also RcssGetPropertyValue().

Usage

RcssGetPropertyValueOrDefault(
  Rcss,
  selector,
  property,
  default = NULL,
  Rcssclass = NULL
)

Arguments

Details

Equivalent to RcssValue(); use RcssValue() instead

Examples

# use RcssValue instead

Overloads base graphics functions by their Rcssplot wrappers

Description

Rcssplot graphics functions have 'Rcss' prefixes, e.g Rcsstext(). This function can be invoked to overload base-graphics functions by their Rcss wrappers. i.e. After executing this function, you can execute e.g. text() and automatically use the Rcss capabilities.

Usage

RcssOverload()

Details

Warning: this function creates masking objects in your current environment for many base-graphics functions. See documentation for details.

Examples

# this function is deprecated - do not use it
suppressWarnings(RcssOverload())

Extract information about property and its value

Description

Extract information about property and its value

Usage

RcssProperty(selector, property, Rcssclass = NULL, Rcss = "default")

Arguments

Value

list with two ites. Component "defined" is a boolean that indicates whether the property is defined in the style. Component "value" gives the actual value associated to the property.

Examples

style1 <- Rcss(text="points { cex: 2; }")
# cex is defined, col is not defined
RcssProperty("points", "cex", Rcss=style1)
RcssProperty("points", "col", Rcss=style1)

Extracts a value from an Rcss object

Description

If the selector and property are defined in the Rcss object, this function will return the value stored in the Rcss object. Otherwise, the function will return a default value. See also related functions RcssGetPropertyValueOrDefault, which is the same, except that RcssValue is shorter to write and takes the Rcss object as its last argument.

Usage

RcssValue(
  selector,
  property,
  default = NULL,
  Rcssclass = NULL,
  Rcss = "default"
)

Arguments

Value

a value from the Rcss object

Examples

style1 <- Rcss(text="custom { key: 100 }")
RcssValue("custom", "key", default=1, Rcss=style1)
RcssValue("custom", "key2", default=0, Rcss=style1)

development tool for adjusting Rcss and R graphics code

Description

This is a macro script that loads R code and a default Rcss style, and then executes a function. This process is repeated indefinitely.

Usage

RcssWatch(f, files = NULL, ...)

Arguments

Examples

# Note: the examples below draw a charat once and exit.
# To enable quick re-drawing, RcssWatch must be provided with file paths

# draw and redraw a bar plot
RcssWatch(plot, x=1:4, y=1:4)

# alternative syntax, using a function name as a string
custom.barplot <- function(x=1:4, main="") { barplot(x, main=main) }
RcssWatch("custom.barplot", main="Custom")

# for more interesting behavior, specify a files with styles and R source

Add a styled straight line to a plot

Description

This is a wrapper for R's abline function. See R's documentation for graphics::abline for further details.

Usage

abline(
  a = NULL,
  b = NULL,
  h = NULL,
  v = NULL,
  reg = NULL,
  coef = NULL,
  Rcss = "default",
  Rcssclass = NULL,
  ...
)

Arguments

Examples

# draw a set of horizontal lines and a vertical line
plot(c(0, 1), c(0, 1), type="n")
abline(h=seq(0, 1, by=0.2))
abline(v=0.8)

Add styled arrows to a plot

Description

This is a wrapper for R's arrows function. See R's documentation for graphics::arrows for further details.

Usage

arrows(x0, y0, x1 = x0, y1 = y0, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# draw an arrow
plot(c(0, 1), c(0, 1), type="n")
arrows(0.2, 0.2, x1=0.8, y1=0.5)

Add a styled axis to a plot

Description

This is a wrapper for R's axis function. See R's documentation for graphics::axis for further details.

Usage

axis(side, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# draw separate axes on an empty plot
plot(c(0, 1), c(0, 1), type="n", axes=FALSE, xlab="x-axis", ylab="")
axis(1)
axis(3)

Draw a styled barplot

Description

This is a wrapper for R's barplot function. See R's documentation for graphics::barplot for further details.

Usage

barplot(height, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# draw a complete barplot
barplot(1:5)

Add a styled box around a plot

Description

This is a wrapper for R's box function. See R's documentation for graphics::box for further details.

Usage

box(which = "plot", Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# draw a box around an existing plot
plot(c(0, 1), c(0, 1), type="n", frame=FALSE)
box(lwd=3)

Draw a styled boxplot

Description

This is a wrapper for R's boxplot function. See R's documentation for graphics::boxplot for further details.

Usage

boxplot(x, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# draw a complete boxplot
dataset <- list(A=rpois(30, 10), B=rpois(30, 20))
boxplot(dataset, col=c("#dd0000", "#dd8888"))

Create a styled cairo_pdf figure

Description

This is a wrapper for R's cairo_pdf function. See R's documentation for grDevices::cairo_pdf for further details

Usage

cairo_pdf(filename, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Details

Note this uses styles from 'pdf' css selectors

Examples

# send content of graphics to a pdf file
# to run this, un-comment the pdf() and dev.off() lines
# cairo_pdf(file="example-file.pdf")
barplot(1:5)
# dev.off()

Draw a styled contour

Description

This is a wrapper for R's contour function. See R's documentation for graphics::contour for further details.

Usage

contour(
  x = seq(0, 1, length.out = nrow(z)),
  y = seq(0, 1, length.out = ncol(z)),
  z,
  Rcss = "default",
  Rcssclass = NULL,
  ...
)

Arguments

Examples

# draw a complete contour plot
dataset <- outer(1:10, 1:10)
contour(z=dataset)

Write styled text into a plot corner

Description

This can be suitable for placing a label in a multi-panel figure. Note the automatic placement does not work when a plot is generated with logarithmic scales.

Usage

ctext(
  label,
  x = NULL,
  y = NULL,
  adj = NULL,
  cex = NULL,
  Rcss = "default",
  Rcssclass = NULL,
  ...
)

Arguments

Examples

plot(1:10, 1:10)
ctext("A")

#' Draw a styled grid

Description

This is a wrapper for R's grid function. See R's documentation for graphics::grid for further details.

Usage

grid(Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# add a grid to an existing plot
plot(c(0, 10), c(0, 10), type="n", xaxs="i", yaxs="i", las=1)
grid(nx=10, ny=5, col="#777777")

Draw a styled histogram

Description

This is a wrapper for R's hist function. See R's documentation for graphics::hist for further details.

Usage

hist(x, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# draw a complete histogram
dataset <- rpois(400, 6)
hist(dataset, breaks=seq(0, max(dataset)))
# only obtain the bin counts, without plotting
histdata <- hist(dataset, breaks=seq(0, 2+max(dataset), by=2), plot=FALSE)
histdata

Create a styled jpg figure

Description

This is a wrapper for R's jpeg function. See R's documentation for grDevices::jpeg for further details

Usage

jpeg(file, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# send content of graphics to a jpg file
# to run this, un-comment the jpeg() and dev.off() lines
# jpeg(file="example-file.jpg")
barplot(1:5)
# dev.off()

Add a styled legend to aplot

Description

This is a wrapper for R's legend function. See R's documentation for graphics::legend for further details.

Usage

legend(x, y = NULL, legend, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# add a legend to an existing plot
plot(1:8, 1:8, col=rep(c(1,2), each=4), pch=19)
legend(7, 3, c("A", "B"), pch=19, col=1:2)

Add styled line segments to a plot

Description

This is a wrapper for R's lines function. See R's documentation for graphics::lines for further details.

Usage

lines(x, y = NULL, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# add lines to an existing plot area
plot(c(0, 10), c(0, 10), type="n")
lines(c(1,8), c(2, 2), lwd=3, col="black")
lines(c(1, 7, NA, 4, 9), c(1, 6, NA, 1, 3), lwd=1, col="blue")
lines(c(8, 3), c(7, 9), lwd=3, lty=2, col="red")

Add styled line segments to a plot

Description

This is a wrapper for R's matplot function. See R's documentation for graphics::matplot for further details.

Usage

matplot(x, y, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# draw scatter based on column in a matrix
dataset = cbind(A=rnorm(20), B=rnorm(20))
matplot(dataset)

Write styled text into a plot margin

Description

This is a wrapper for R's mtext function. See R's documentation for graphics::mtext for further details.

Usage

mtext(text, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# draw text into a margin
plot(c(0, 1), c(0, 1), type="n", xlab="", ylab="")
mtext(side=1, "bottom x-axis label", line=2.5)
mtext(side=2, "left y-axis label", line=2.5)
mtext(side=3, "top x-axis label")
mtext(side=4, "right y-axis label")

Set styled parameters for base graphics

Description

This is a wrapper for R's par function. See R's documentation for graphics::par for further details.

Usage

par(Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# set properties for plot
par(ps=8, mar=c(3, 8, 3, 1))
plot(c(0, 1), c(0, 1), type="n", frame=FALSE)
text(rep(0.5, 2), c(0.2, 0.5), c("abc", "def"))
par(ps=12)
text(0.5, 0.8, "xyz")

combination of par and plot

Description

The sequence of par() and plot() occurs so frequently that it a shortcut is helpful.

Usage

parplot(x, y, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

parplot(x=1:4, y=c(1,3,2,4))

Create a styled pdf figure

Description

This is a wrapper for R's pdf function. See R's documentation for grDevices::pdf for further details

Usage

pdf(file, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# send content of graphics to a pdf file
# to run this, un-comment the pdf() and dev.off() lines
# png(file="example-file.pdf")
barplot(1:5)
# dev.off()

Create a styled plot

Description

This is a wrapper for R's plot function. See R's documentation for graphics::plot for further details.

Usage

plot(x, y, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# draw a new empty plot area - unit square
plot(c(0, 1), c(0, 1), type="n", xlab="", ylab="")
# draw a plot area, automatically add some points
plot(runif(20), rpois(20, 100))

Create a styled png figure

Description

This is a wrapper for R's png function. See R's documentation for grDevices::png for further details.

Usage

png(file, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# send content of graphics to a png file
# to run this, un-comment the png() and dev.off() lines
# png(file="example-file.png")
barplot(1:5)
# dev.off()

Add styled points to a plot

Description

This is a wrapper for R's points function. See R's documentation for graphics::points for further details.

Usage

points(x, y = NULL, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# draw a set of points onto an existing plot
plot(c(0, 1), c(0, 1), type="n")
points(runif(10), runif(10))
points(runif(10), runif(10), col="blue", pch=19)

Draw a styled polygon on a plot

Description

This is a wrapper for R's polygon function. See R's documentation for graphics::polygon for further details.

Usage

polygon(x, y = NULL, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# draw a multi-sided shape on an existing plot
plot(c(0, 10), c(0, 10), type="n", xlab="", ylab="")
polygon(c(1, 4, 7, 7, 1), c(1, 1, 4, 8, 8), col="blue")

Show basic information about an Rcss object

Description

Display selectors encoded in an Rcss object. For more detailed information about the object, see function printRcss()

Usage

## S3 method for class 'Rcss'
print(x, ...)

Arguments

Examples

# define a custom style, display it
custom.style <- Rcss(text="points { cex: 2; }")
custom.style

Display properties encoded in an Rcss object

Description

Display properties encoded in an Rcss object, including any subclasses.

Usage

printRcss(Rcss, selector = NULL, verbose = FALSE)

Arguments

Examples

# define a custom style
custom.style <- Rcss(text="points { pch:2; } points.A { pch: 3; }")

# printing details for a selector, concise and verbose
printRcss(custom.style, "points")
printRcss(custom.style, "points", verbose=TRUE)

Draw styled rectangles on a plot

Description

This is a wrapper for R's rect function. See R's documentation for graphics::rect for further details.

Usage

rect(xleft, ybottom, xright, ytop, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# draw rectangles on an existing plot
plot(c(0, 10), c(0, 10), type="n", xlab="", ylab="")
rect(4.5, 1, 5.5, 3)
rect(c(1, 7.5), c(6, 6), c(2.5, 9), c(8, 8))

Draw styled strip chart

Description

This is a wrapper for R's stripchart function. See R's documentation for graphics::stripchart for further details.

Usage

stripchart(x, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# draw a complete strip-chart plot
dataset <- list(A=c(1,9,3,8), B=c(3,4,2,9,2), C=rpois(8, 10))
stripchart(dataset)
stripchart(dataset, method="jitter", vertical=TRUE, pch=19)

Create a styled svg figure

Description

This is a wrapper for R's svg function. See R's documentation for grDevices::svg for further details

Usage

svg(filename, Rcss = "default", Rcssclass = NULL, ...)

Arguments

Examples

# send content of graphics to a pdf file
# to run this, un-comment the pdf() and dev.off() lines
# svg(file="example-file.svg")
barplot(1:5)
# dev.off()

Add styled text to a plot

Description

This is a wrapper for R's text function. See R's documentation for graphics::text for further details.

Usage

text(
  x,
  y = NULL,
  labels = seq_along(x),
  Rcss = "default",
  Rcssclass = NULL,
  ...
)

Arguments

Examples

# add text to an existing plot
plot(c(0, 1), c(0, 1), type="n")
text(0.1, 0.1, "A")
text(c(0.2, 0.7), c(0.8, 0.6), c("B", "C"))

Add styled annotation to a plot

Description

This is a wrapper for R's title function. See R's documentation for graphics::title for further details.

Usage

title(
  main = NULL,
  sub = NULL,
  xlab = NULL,
  ylab = NULL,
  Rcss = "default",
  Rcssclass = NULL,
  ...
)

Arguments

Examples

# add a title
plot(c(0, 1), c(0, 1), type="n", xlab="", ylab="")
title("This is the title")
title(sub="This is a bottom title")