areaBand: Create a band chart

In ddplot: Create D3 Based SVG Graphics

Create a band chart

Description

Create a band chart

Usage

areaBand(
  data,
  x,
  yLower,
  yUpper,
  fill = "crimson",
  stroke = NULL,
  strokeWidth = NULL,
  xticks = NULL,
  yticks = NULL,
  xtitle = NULL,
  xtitleFontSize = 16,
  ytitle = NULL,
  ytitleFontSize = 16,
  title = NULL,
  titleFontSize = 22,
  font = "Verdana, Geneva, Tahoma, sans-serif",
  bgcol = "#CAD0D3",
  opacity = 1,
  axisCol = "black",
  width = NULL,
  height = NULL
)

Arguments

data	The data frame containing the variables to consider.
x	The x-variable to consider. Must be a date variable in 'yyyy-mm-dd' format.
yLower	The y-lower band variable to consider.
yUpper	The y-upper band variable to consider.
fill	The color of the band. Defaults to 'crimson'.
stroke	Optional. The color of the stroke of the band.
strokeWidth	Optional. The width of the band stroke.
xticks	Optional. the number of x-axis ticks to consider.
yticks	Optional. The number of y-axis ticks to consider.
xtitle	Optional. The title of the x-axis.
xtitleFontSize	The font size of the x-axis title. Defaults to 16.
ytitle	Optional. The title of the y-axis.
ytitleFontSize	The font size of the y-axis title. Defaults to 16.
title	Optional. The title of the plot.
titleFontSize	The font size of the plot title. Defaults to 22.
font	The font family to consider for the titles. Defaults to "Verdana, Geneva, Tahoma, sans-serif".
bgcol	The background color of the SVG. Defaults to "#CAD0D3" HEX color.
opacity	The color opacity of the area chart (from 0 to 1). Defaults to 1.
axisCol	the color of the x and y axis. It includes the ticks, the labels and titles. Defaults to 'black'.
width	Optional. The width of the SVG output.
height	Optional. The height of the SVG output.

Value

A SVG band chart

Examples

airpassengers <- data.frame(
 passengers_lower = as.matrix(AirPassengers),
 passengers_upper = as.matrix(AirPassengers) + 40,
 date= zoo::as.Date(time(AirPassengers))
)

areaBand(
 data = airpassengers,
 x = "date",
 yLower = "passengers_lower",
 yUpper = "passengers_upper",
 fill = "yellow",
 stroke = "black"
)

ddplot documentation built on Dec. 2, 2022, 5:12 p.m.