gvisCandlestickChart: Google Candlestick chart with R \Sexpr{googleChartName <-...

In googleVis: R Interface to Google Charts

Google Candlestick chart with R \Sexpr{googleChartName <- "candlestickchart"} \Sexpr{gvisChartName <- "gvisCandlestickChart"}

Description

An interactive candlestick chart.

Usage

gvisCandlestickChart(
  data,
  xvar = "",
  low = "",
  open = "",
  close = "",
  high = "",
  options = list(),
  chartid
)

Arguments

data	a data.frame to be displayed as a candlestick chart. The data has to have at least 5 columns.
xvar	name of the character column which contains the category labels for the x-axes.
low	name of the numeric column specifying the low/minimum value of this marker. This is the base of the candle's center line.
open	name of the numeric column specifying the opening/initial value of this marker. This is one vertical border of the candle. If less than the close value, the candle will be filled; otherwise it will be hollow.
close	name of the numeric column specifying the closing/final value of this marker. This is the second vertical border of the candle. If less than the open value, the candle will be hollow; otherwise it will be filled.
high	name of the numeric column specifying the high/maximum value of this marker. This is the top of the candle's center line.
options	list of configuration options, see: \Sexpr[results=rd]{gsub("CHARTNAME", googleChartName, readLines(file.path(".", "inst", "mansections", "GoogleChartToolsURLConfigOptions.txt")))} \Sexpr[results=rd]{paste(readLines(file.path(".", "inst", "mansections", "gvisOptions.txt")))}
chartid	character. If missing (default) a random chart id will be generated based on chart type and tempfile

Details

The gvisCandlestickChart function reads a data.frame and creates text output referring to the Google Visualisation API, which can be included into a web page, or as a stand-alone page. The actual chart is rendered by the web browser using SVG or VML.

A candlestick chart is used to show an opening and closing value overlaid on top of a total variance. Candlestick charts are often used to show stock value behavior. In this chart, items where the opening value is less than the closing value (a gain) are drawn as filled boxes, and items where the opening value is more than the closing value (a loss) are drawn as hollow boxes.

Value

\Sexpr[results=rd]{paste(gvisChartName)}

returns list of class \Sexpr[results=rd]{paste(readLines(file.path(".", "inst", "mansections", "gvisOutputStructure.txt")))}

Author(s)

Markus Gesmann [e-mail],

Diego de Castillo [e-mail]

References

Google Chart Tools API: \Sexpr[results=rd]{gsub("CHARTNAME", googleChartName, readLines(file.path(".", "inst", "mansections", "GoogleChartToolsURL.txt")))}

See Also

See also print.gvis, plot.gvis for printing and plotting methods

Examples

## Please note that by default the googleVis plot command
## will open a browser window and requires an internet
## connection to display the visualisation.

## Example data set
OpenClose

C1 <- gvisCandlestickChart(OpenClose, xvar="Weekday", low="Low",
                                      open="Open", close="Close",
                                      high="High",
                                      options=list(legend='none'))

plot(C1)

googleVis documentation built on May 29, 2024, 9:24 a.m.