ds4psy (version 0.1.0)

plot_fn: A function to plot a plot.

Description

plot_fn is a function that uses parameters for plotting a plot.

Usage

plot_fn(x = NA, y = 1, A = TRUE, B = FALSE, C = TRUE,
  D = FALSE, E = FALSE, F = FALSE, f = c(rev(pal_seeblau), "white",
  pal_pinky), g = "white")

Arguments

x

A (natural) number. Default: x = NA.

y

A (decimal) number. Default: y = 0.

A

A Boolean value. Default: A = TRUE.

B

A Boolean value. Default: B = FALSE.

C

A Boolean value. Default: C = TRUE.

D

A Boolean value. Default: D = FALSE.

E

A Boolean value. Default: E = FALSE.

F

A Boolean value. Default: F = FALSE.

f

A color palette (e.g., as a vector). Default: f = c(rev(pal_seeblau), "white", pal_pinky). Note: Using colors of the unikn package by default.

g

A color (e.g., as a character). Default: g = "white".

Details

plot_fn is deliberately kept cryptic and obscure to illustrate how function parameters can be explored (and why transparent variable names are essential for understanding and using a function).

See Also

plot_fun for a related function; pal_ds4psy for color palette.

Other plot functions: plot_fun, plot_n, plot_tiles, theme_ds4psy

Examples

# NOT RUN {
# Basics: 
plot_fn()

# Exploring options: 
plot_fn(x = 2, A = TRUE)
plot_fn(x = 3, A = FALSE, E = TRUE)
plot_fn(x = 4, A = TRUE,  B = TRUE, D = TRUE)
plot_fn(x = 5, A = FALSE, B = TRUE, E = TRUE, f = c("black", "white", "gold"))
plot_fn(x = 7, A = TRUE,  B = TRUE, F = TRUE, f = c("steelblue", "white", "forestgreen"))

# }