R: Google Annotated Time Line with R

gvisAnnotatedTimeLine {googleVis} | R Documentation

## Google Annotated Time Line with R

### Description

The gvisAnnotatedTimeLine 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.

### Usage

    gvisAnnotatedTimeLine(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: https://developers.google.com/chart/interactive/docs/gallery/annotatedtimeline#Configuration_Options The parameters can be set via a named list. The parameters have to map those of the Google documentation. Boolean arguments are set to either `TRUE` or `FALSE`, using the R syntax. Google API parameters with a single value and with names that don't include a "." are set like one would do in R, that is `options=list(width=200, height=300)`. Exceptions to this rule are the width and height options for `gvisAnnotatedTimeLine` and `gvisAnnotationChart`. For those two functions, width and height must be character strings of the format `"Xpx"`, where `X` is a number, or `"automatic"`. For example, `options=list(width="200px", height="300px")`. Google API parameters with names that don't include a ".", but require multivalues are set as a character, wrapped in "[ ]" and separated by commas, e.g. `options=list(colors="['#cbb69d', '#603913', '#c69c6e']")` Google API parameters with names that do include a "." present parameters with several sub-options and have to be set as a character wrapped in " ". The values of those sub-options are set via parameter:value. Boolean values have to be stated as `'true'` or `'false'`. For example the Google documentaion states the formating options for the vertical axis and states the parameter as `vAxis.format`. Then this paramter can be set in R as: `options=list(vAxis="{format:'#,###%'}")`. If several sub-options have to be set, e.g. `titleTextStyle.color`, `titleTextStyle.fontName` and `titleTextStyle.fontSize`, then those can be combined in one list item such as: `options=list(titleTextStyle="{color:'red', fontName:'Courier', fontSize:16}")` paramters that can have more than one value per sub-options are wrapped in "[ ]". For example to set the labels for left and right axes use: `options=list(vAxes="[{title:'val1'}, {title:'val2'}]")` `gvis.editor` a character label for an on-page button that opens an in-page dialog box enabling users to edit, change and customise the chart. By default no value is given and therefore no button is displayed. For more details see the Google API documentation and the R examples below.
`chartid` | character. If missing (default) a random chart id will be generated based on chart type and `tempfile`

### Details

An annotated time line is an interactive time series line chart with optional annotations. The chart is rendered within the browser using Flash.

### Value

gvisAnnotatedTimeLine returns list of `class` "`gvis`" and "`list`". An object of class "`gvis`" is a list containing at least the following components:

`type`

  Google visualisation type

`chartid`

  character id of the chart object. Unique chart ids are required to place several charts on the same page.

`html`

  a list with the building blocks for a page

  `header`

    a character string of a html page header: `<html>...<body>`,

  `chart`

    a named character vector of the chart's building blocks:

    `jsHeader`

      Opening `<script>` tag and reference to Google's JavaScript library.

    `jsData`

      JavaScript function defining the input `data` as a JSON object.

    `jsDrawChart`

      JavaScript function combing the data with the visualisation API and user options.

    `jsDisplayChart`

      JavaScript function calling the handler to display the chart.

    `jsFooter`

      End tag `</script>`.

    `jsChart`

      Call of the `jsDisplayChart` function.

    `divChart`

      `<div>` container to embed the chart into the page.

  `caption`

    character string of a standard caption, including data name and chart id.

  `footer`

    character string of a html page footer: `</body>...</html>`, including the used R and googleVis version and link to Google's Terms of Use.

### Warnings

AnnotatedTimeline (gvisAnnotatedTimeLine) is Flash based, conisder using AnnotationChart (gvisAnnotationChart) instead. For more details visit: goo.gl/tkiEV8

Because of Flash security settings the chart might not work correctly when accessed from a file location in the browser (e.g., file:///c:/webhost/myhost/myviz.html) rather than from a web server URL (e.g. http://www.myhost.com/myviz.html). See the googleVis package vignette and the Macromedia web site (http://www.macromedia.com/support/documentation/en/flashplayer/help/) for more details.

Important: To use this visualization, you must specify the height and width of the container element explicitly on your page. So, for example: options=list(width="600px", height="350px")

Use codegvisAnnotationChart for a non-Flash version of this plot.

### Author(s)

Markus Gesmann markus.gesmann@gmail.com,

Diego de Castillo decastillo@gmail.com

### References

Google Chart Tools API: http://developers.google.com/chart/interactive/docs/gallery/annotatedtimeline

### 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.

### Examples

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

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

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

    ## Zoom into the time window, no Y-axis ticks
    A3 <- gvisAnnotatedTimeLine(Stock, datevar="Date",
                               numvar="Value", idvar="Device",
                               titlevar="Title", annotationvar="Annotation",
                               options=list(
                                 width="600px", height="350px",
                                zoomStartTime=as.Date("2008-01-04"),
                                zoomEndTime=as.Date("2008-01-05"))
                              )
    plot(A3)

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

    plot(A4)

    ## Data with POSIXct datetime variable
    A5 <- gvisAnnotatedTimeLine(Andrew, datevar="Date/Time UTC",
                                numvar="Pressure_mb",
                                options=list(scaleType='maximized',
                                             width="600px", height="350px")
                                )

    plot(A5)

    ## Not run:

    ## Plot Apple's monthly stock prices since 1984

    ## Get current date
    d <- Sys.time()
    current.year <- format(d, "%Y")
    current.month <- format(d, "%m")
    current.day <- format(d, "%d")

    ## Yahoo finance sets January to 00 hence:
    month <- as.numeric(current.month)  - 1
    month <- ifelse(month < 10, paste("0",month, sep=""), m)

    ## Get weekly stock prices from Apple Inc.
    tckr <- 'AAPL'
    yahoo <- 'http://ichart.finance.yahoo.com/table.csv'

    fn <- sprintf('%s?s=%s&a=08&b=7&c=1984&d=%s&e=%s&f=%s&g=w&ignore=.csv',
          yahoo, tckr, month, current.day, current.year)

    ## Get data from Yahoo! Finance
    data <- read.csv(fn, colClasses=c("Date", rep("numeric",6)))

    AAPL <- reshape(data[,c("Date", "Close", "Volume")], idvar="Date",
         		times=c("Close", "Volume"),
                    timevar="Type",
                    varying=list(c("Close", "Volume")),
                    v.names="Value",
                    direction="long")

    ## Calculate previous two years for zoom start time
    lyd <- as.POSIXlt(as.Date(d))
    lyd$year <- lyd$year-2
    lyd <- as.Date(lyd)

    aapl <- gvisAnnotatedTimeLine(AAPL, datevar="Date",
                               numvar="Value", idvar="Type",
                              options=list(
                                colors="['blue', 'lightblue']",
                                zoomStartTime=lyd,
                                zoomEndTime=as.Date(d),
                                legendPosition='newRow',
                                width="600px", height="400px", scaleColumns='[0,1]',
                                scaleType='allmaximized')
                               )

    plot(aapl)

    ## End(Not run)

[Package googleVis version 0.6.2 Index]