gvisAnnotationChart function

Google Annotation Chart with R googleChartName <- "annotationchart"

gvisChartName <- "gvisAnnotationChart"

gvisAnnotationChart charts are interactive time series line charts that support annotations. Unlike the gvisAnnotatedTimeLine, which uses Flash, annotation charts are SVG/VML and should be preferred whenever possible.

gvisAnnotationChart(
  data,
  datevar = "",
  numvar = "",
  idvar = "",
  titlevar = "",
  annotationvar = "",
  date.format = "%Y/%m/%d",
  options = list(),
  chartid
)

Arguments

• data: a data.frame. The data has to have at least two columns, one with date information (datevar) and one numerical variable.

• datevar: column name of data which shows the date dimension. The information has to be of class Date or POSIX* time series.

• numvar: column name of data which shows the values to be displayed against datevar. The information has to be numeric.

• idvar: column name of data which identifies different groups of the data. The information has to be of class character or factor.

• titlevar: column name of data which shows the title of the annotations. The information has to be of class character or factor. Missing information can be set to NA. See section 'Details' for more details.

• annotationvar: column name of data which shows the annotation text. The information has to be of class character or factor. Missing information can be set to NA. See section 'Details' for more details.

• date.format: if datevar is of class Date then this argument specifies how the dates are reformatted to be used by JavaScript.

• options: list of configuration options, see:

  gsub("CHARTNAME", googleChartName, readLines(file.path(".", "inst","mansections", "GoogleChartToolsURLConfigOptions.txt")))

  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.

Returns

paste(gvisChartName) returns list of class

paste(readLines(file.path(".", "inst", "mansections","gvisOutputStructure.txt")))

Examples

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

data(Stock)
Stock
A1 <- gvisAnnotationChart(Stock, datevar="Date",
                           numvar="Value", idvar="Device",
                           titlevar="Title", annotationvar="Annotation",
                           options=list(displayAnnotations=TRUE,
                            legendPosition='newRow',
                            width=600, height=350)
                           )
plot(A1)

## Two Y-axis
A2 <- gvisAnnotationChart(Stock, datevar="Date",
                           numvar="Value", idvar="Device",
                           titlevar="Title", annotationvar="Annotation",
                           options=list(displayAnnotations=TRUE, 
                            width=600, height=350, scaleColumns='[0,1]',
                            scaleType='allmaximized')
                          )
plot(A2)


## Colouring the area below the lines to create an area chart
A3 <- gvisAnnotationChart(Stock, datevar="Date",
                           numvar="Value", idvar="Device",
                           titlevar="Title", annotationvar="Annotation",
                           options=list(
                             width=600, height=350,
                             fill=10, displayExactValues=TRUE,
                             colors="['#0000ff','#00ff00']")
                           )
                          
plot(A3)

## Data with POSIXct datetime variable
A4 <- gvisAnnotationChart(Andrew, datevar="Date/Time UTC",
                            numvar="Pressure_mb",
                            options=list(scaleType='maximized')
                            )

plot(A4)

# Change background to blue
A5 <- gvisAnnotationChart(Stock, datevar="Date",
              numvar="Value", idvar="Device",
              titlevar="Title", annotationvar="Annotation",
              options=list(
                displayAnnotations=TRUE,
                  chart = "{chartArea:{backgroundColor:'#003b70'}}",
                            legendPosition='newRow',
                            width=600, height=350))
                            
plot(A5)

References

Google Chart Tools API: gsub("CHARTNAME", googleChartName, readLines(file.path(".", "inst","mansections", "GoogleChartToolsURL.txt")))

See Also

See also print.gvis, plot.gvis for printing and plotting methods. Further see reshape for reshaping data, e.g. from a wide format into a long format.

Author(s)

Markus Gesmann markus.gesmann@gmail.com , Diego de Castillo decastillo@gmail.com