gvisGauge

0th

Percentile

Google Gauge with R gauge

gvisGauge

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

Keywords
iplot
Usage
gvisGauge(data, labelvar = "", numvar = "", options = list(), chartid)
Arguments
data
a data.frame to be displayed as a gauge
labelvar
name of the character column which contains the category labels for the slice labels.
numvar
a vector of column names of the numerical variables of the slice values.
options
list of configuration options, see:

https://developers.google.com/chart/interactive/docs/gallery/gauge#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
    Value

    gvisGauge 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: ...,
    chart
    a named character vector of the chart's building blocks:
    jsHeader
    Opening .
    jsChart
    Call of the jsDisplayChart function.
    divChart
    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: ..., including the used R and googleVis version and link to Google's Terms of Use.

    References

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

    See Also

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

    Aliases
    • gvisGauge
    Examples
    
    ## Please note that by default the googleVis plot command
    ## will open a browser window and requires an internet
    ## connection to display the visualisation.
    
    Gauge1 <- gvisGauge(CityPopularity, options=list(min=0, max=800, greenFrom=500,
                        greenTo=800, yellowFrom=300, yellowTo=500,
                        redFrom=0, redTo=300))
    
    plot(Gauge1)
    
    
    Documentation reproduced from package googleVis, version 0.6.0, License: GPL (>= 2)

    Community examples

    Looks like there are no examples yet.