gvisScatterChart: Google Scatter Chart with R

In kleanthisk10/google-motion-charts-with-r: Interface between R and the Google Chart Tools

Description

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

Usage

gvisScatterChart(data, options = list(), chartid)

Arguments

data	a data.frame to be displayed as a scatter chart. Two or more columns are required, all must be numeric. The values in the first column are used for the X-axis. The values in following columns are used for the Y-axis. Each column is displayed with a separate color.
options	list of configuration options for Google Scatter Chart. gvis.editor a character label for an on-page button which opens an in-page dialog box that enables users to edit, change and customise the chart. By default no value is given and therefore no button is displayed. Further possible components are, taken from https://google-developers.appspot.com/chart/interactive/docs/gallery/scatterchart.html#Configuration_Options: axisTitlesPosition a string. Default 'out'. Where to place the axis titles, compared to the chart area. Supported values: 'in' Draw the axis titles inside the the chart area. 'out' Draw the axis titles outside the chart area. 'none' Omit the axis titles. backgroundColor a string or object. Default 'white'. The background color for the main area of the chart. Can be either a simple HTML color string, for example: 'red' or '#00cc00', or an object with the following properties. backgroundColor.stroke a string. Default '#666'. The color of the chart border, as an HTML color string. backgroundColor.strokeWidth a number. Default 0. The border width, in pixels. backgroundColor.fill a string. Default 'white'. The chart fill color, as an HTML color string. chartArea a string. Default 'null'. An object with members to configure the placement and size of the chart area (where the chart itself is drawn, excluding axis and legends). Two formats are supported: a number, or a number followed by %. A simple number is a value in pixels; a number followed by % is a percentage. Example: {left:20,top:0,width:\"50%\",height:\"75%\"} chartArea.left a number or string. Default auto. How far to draw the chart from the left border. chartArea.top a number or string. Default auto. How far to draw the chart from the top border. chartArea.width a number or string. Default auto. Chart area width. chartArea.height a number or string. Default auto. Chart area height. colors a JSON array of strings. Default 'colors'. The colors to use for the chart elements. An array of strings, where each element is an HTML color string, for example: colors:['red','#004411']. curveType a string. Default 'none'. Controls the curve of the lines. Can be one of the following: 'none' Straight lines without curve. 'function' The angles of the line will be smoothed. enableInteractivity boolean. Default TRUE. Whether the chart throws user-based events or reacts to user interaction. If false, the chart will not throw 'select' or other interaction-based events (but will throw ready or error events), and will not display hovertext or otherwise change depending on user input. fontSize a number. Default automatic. The default font size, in pixels, of all text in the chart. You can override this using properties for specific chart elements. fontName a string. Default 'Arial'. The default font face for all text in the chart. You can override this using properties for specific chart elements. gridlineColor a string. Default '#CCC'. The color of the gridlines inside the chart area. Specify a valid HTML color string. hAxis a JSON object. Default 'null'. An object with members to configure various horizontal axis elements. To specify properties of this object, you can use object literal notation, as shown here: {title: 'Hello', titleTextStyle: {color: '#FF0000'}} hAxis.baseline a number. Default automatic. hAxis property that specifies the baseline for the horizontal axis. If the baseline is smaller than the highest grid line or smaller than the lowest grid line, it will be rounded to the closest gridline. hAxis.baselineColor a string. Default 'black'. hAxis property that specifies the color of the baseline for the horizontal axis. Can be any HTML color string, for example: 'red' or '#00cc00'. hAxis.direction 1 or -1. Default 1. The direction in which the values along the horizontal axis grow. Specify -1 to reverse the order of the values. hAxis.format a string. Default auto. a format string for numeric axis labels. This is a subset of the ICU pattern set. For instance, {format:'#,###%'}. will display values 1,000%, 750%, and 50% for values 10, 7.5, and 0.5. hAxis.gridlines a JSON object. Default null. An object with members to configure the gridlines on the horizontal axis. To specify properties of this object, you can use object literal notation, as shown here: {color: '#333', count: 4} This option is only supported for a continuous axis. hAxis.gridlines.color a string. Default '#CCC'. The color of the horizontal gridlines inside the chart area. Specify a valid HTML color string. hAxis.gridlines.count a number. Default 5.The number of vertical gridlines inside the chart area. Minimum value is 2. hAxis.logScale boolean. Default FALSE. vAxis property that makes the vertical axis a logarithmic scale (requires all values to be positive). Set to TRUE for yes. hAxis.textPosition a string. Default 'out' Position of the horizontal axis text, relative to the chart area. Supported values: 'out', 'in', 'none'. hAxis.textStyle a JSON object. Default {color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>} An object that specifies the horizontal axis text style. The object has this format: {color: <string>, fontName: <string>, fontSize: <number>} The color can be any HTML color string, for example: 'red' or '#00cc00'. Also see fontName and fontSize. hAxis.title a string. Default 'null'. hAxis property that specifies the title of the horizontal axis. hAxis.titleTextStyle a JSON object. Default {color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>}. An object that specifies the horizontal axis title text style. The object has this format: {color: <string>, fontName: <string>, fontSize: <number>} The color can be any HTML color string, for example: 'red' or '#00cc00'. Also see fontName and fontSize. hAxis.maxValue a number. Default automatic. hAxis property that specifies the highest vertical axis grid line. The actual grid line will be the greater of two values: the maxValue option value, or the highest data value, rounded up to the next higher grid mark. hAxis.minValue a number. Default automatic. hAxis property that specifies the lowest vertical axis grid line. The actual grid line will be the lower of two values: the minValue option value, or the lowest data value, rounded down to the next lower grid mark. hAxis.viewWindowMode a string. Default "pretty" if hAxis.viewWindow is null, "explicit" otherwise. Specifies how to scale the horizontal axis to render the values within the chart area. The following string values are supported: 'pretty' Scale the horizontal values so that the maximum and minimum data values are rendered a bit inside the left and right of the chart area. 'maximized' Scale the horizontal values so that the maximum and minimum data values touch the left and right of the chart area. 'explicit' Specify the left and right scale values of the chart area. Data values outside these values will be cropped. You must specify a hAxis.viewWindow object describing the maximum and minimum values to show. hAxis.viewWindow Object. Default NULL. Specifies the maximum and minimum data values to show on the horizontal axis. Present only if vAxis.viewWindowMode='explicit' hAxis.viewWindow.max A number. Default 0. The maximum vertical data value to render. hAxis.viewWindow.min A number. Default 0. The minimum vertical data value to render. height a number. Default height of the containing element. Height of the chart, in pixels. legend a JSON object. Default NULL. An object with members to configure various aspects of the legend. To specify properties of this object, you can use object literal notation, as shown here: {position: 'top', textStyle: {color: 'blue', fontSize: 16}} legend.position a string. Default 'right'. Position of the legend. Can be one of the following: 'right' To the right of the chart. 'top' Above the chart. 'bottom' Below the chart. 'none' No legend is displayed. legend.textStyle a JSON object. Default {color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>} An object that specifies the legend text style. The object has this format: {color: <string>, fontName: <string>, fontSize: <number>} The color can be any HTML color string, for example: 'red' or '#00cc00'. Also see fontName and fontSize. lineWidth a number. Default 2. Line width in pixels. Use zero to hide all lines and show only the points. pointSize a number. Default 0. Diameter of data points, in pixels. Use zero to hide all points. series a JSON array of objects, or object with nested objects. Default {}. An array of objects, each describing the format of the corresponding series in the chart. To use default values for a series, specify an empty object . If a series or a value is not specified, the global value will be used. Each object supports the following properties: color The color to use for this series. Specify a valid HTML color string. targetAxisIndex Which axis to assign this series to, where 0 is the default axis, and 1 is the opposite axis. Default value is 0; set to 1 to define a chart where different series are rendered against different axes. You can define a different scale for different axes. pointSize Overrides the global pointSize value for this series. lineWidth Overrides the global lineWidth value for this series. curveType Overrides the global curveType value for this series. visibleInLegend A boolean value, where true means that the series should have a legend entry, and false means that it should not. Default is TRUE. You can specify either an array of objects, each of which applies to the series in the order given, or you can specify an object where each child has a numeric key indicating which series it applies to. For example, the following two declarations are identical, and declare the first series as black and absent from the legend, and the fourth as red and absent from the legend: series: [{color: 'black', visibleInLegend: false},{}, {}, {color: 'red', visibleInLegend: false}] series: {0:{color: 'black', visibleInLegend: false}, 3:{color: 'red', visibleInLegend: false}} theme a string. Default NULL. A theme is a set of predefined option values that work together to achieve a specific chart behavior or visual effect. Currently only one theme is available: maximized Maximizes the area of the chart, and draws the legend and all of the labels inside the chart area. Sets the following options: chartArea: {width: '100%', height: '100%'}, legend: {position: 'in'}, titlePosition: 'in', axisTitlesPosition: 'in', hAxis: {textPosition: 'in'}, vAxis: {textPosition: 'in'} title a string. Default no title. Text to display above the chart. titlePosition a string. Default 'out'. Where to place the chart title, compared to the chart area. Supported values: 'in' Draw the title inside the chart area. 'out' Draw the title outside the chart area. 'none' Omit the title. titleTextStyle a JSON object. Default {color:'black', fontName:<global-font-name>,fontSize:<global-font-size>}. An object that specifies the title text style. The object has this format: {color: <string>, fontName: <string>, fontSize: <number>} The color can be any HTML color string, for example: 'red' or '#00cc00'. Also see fontName and fontSize. tooltip a JSON object. Default NULL. An object with members to configure various tooltip elements. To specify properties of this object, you can use object literal notation, as shown here: {textStyle: {color: '#FF0000'}, showColorCode: true} tooltip.showColorCode boolean. Default automatic. If true, show colored squares next to the series information in the tooltip. The default is true when focusTarget is set to 'category', otherwise the default is FALSE. tooltip.textStyle a JSON object. Default {color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>} An object that specifies the tooltip text style. The object has this format: {color: <string>, fontName: <string>, fontSize: <number>} The color can be any HTML color string, for example: 'red' or '#00cc00'. Also see fontName and fontSize. tooltip.trigger The user interaction that causes the tooltip to be displayed: 'hover' The tooltip will be displayed when the user hovers over an element. 'none' The tooltip will not be displayed. vAxis a JSON object. Default 'null'. An object with members to configure various vertical axis elements. To specify properties of this object, you can use object literal notation, as shown here: {title: 'Hello', titleTextStyle: {color: '#FF0000'}} vAxis.baseline a number. Default automatic. vAxis property that specifies the baseline for the vertical axis. If the baseline is smaller than the highest grid line or smaller than the lowest grid line, it will be rounded tothe closest gridline. vAxis.baselineColor a string. Default 'black'. vAxis property that specifies the color of the baseline for the vertical axis. Can be any HTML color string, for example: 'red' or '#00cc00'. vAxis.direction 1 or -1. Default 1. The direction in which the values along the vertical axis grow. Specify -1 to reverse the order of the values. vAxis.format a string. Default auto. A format string for numeric axis labels. This is a subset of the ICU pattern set. For instance, {format:'#,###%'}. will display values 1,000%, 750%, and 50% for values 10, 7.5, and 0.5. vAxis.gridlines a JSON object. Default NULL. An object with members to configure the gridlines on the vertical axis. To specify properties of this object, you can use object literal notation, as shown here: {color: '#333', count: 4} vAxis.gridlines.color a string. Default '#CCC'. The color of the vertical gridlines inside the chart area. Specify a valid HTML color string. vAxis.gridlines.count a number. Default 5.The number of vertical gridlines inside the chart area. Minimum value is 2. vAxis.logScale boolean. Default FALSE. vAxis property that makes the vertical axis a logarithmic scale (requires all values to be positive). Set to TRUE for yes. vAxis.textPosition a string. Default 'out'. Position of the vertical axis text, relative to the chart area. Supported values: 'out', 'in', 'none'. vAxis.textStyle a JSON object. Default {color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>}. An object that specifies the vertical axis text style. The object has this format: {color: <string>, fontName: <string>, fontSize: <number>} The color can be any HTML color string, for example: 'red' or '#00cc00'. Also see fontName and fontSize. vAxis.title a string. Default no title. vAxis property that specifies a title for the vertical axis. vAxis.titleTextStyle a JSON object. Default {color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>}. An object that specifies the vertical axis title text style. The object has this format: {color: <string>, fontName: <string>, fontSize: <number>} The color can be any HTML color string, for example: 'red' or '#00cc00'. Also see fontName and fontSize. vAxis.maxValue a number. Default automatic. vAxis property that specifies the highest vertical axis grid line. The actual grid line will be the greater of two values: the maxValue option value, or the highest data value, rounded up to the next higher grid mark. vAxis.minValue a number. Default automatic. vAxis property that specifies the lowest vertical axis grid line. The actual grid line will be the lower of two values: the minValue option value, or the lowest data value, rounded down to the next lower grid mark. vAxis.viewWindowMode a string. Default "pretty" if vAxis.viewWindow is null, "explicit" otherwise. Specifies how to scale the vertical axis to render the values within the chart area. The following string values are supported: 'pretty' Scale the vertical values so that the maximum and minimum data values are rendered a bit inside the top and bottom of the chart area. 'maximized' Scale the vertical values so that the maximum and minimum data values touch the top and bottom of the chart area. 'explicit' Specify the top and bottom scale values of the chart area. Data values outside these values will be cropped. You must specify a vAxis.viewWindow object describing the maximum and minimum values to show. vAxis.viewWindow Object. Default NULL. Specifies the maximum and minimum data values to show on the vertical axis. Present only if vAxis.viewWindowMode='explicit' vAxis.viewWindow.max A number. Default 0. The maximum vertical data value to render. vAxis.viewWindow.min A number. Default 0. The minimum vertical data value to render. width a number. Default width of the containing element. Width of the chart, in pixels.
chartid	character. If missing (default) a random chart id will be generated based on chart type and tempfile

Value

gvisScatterChart 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, here 'ScatterChart'
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.

Warning

Google Visualisation API: You cannot load both scatterchart and corechart packages at the same time on the same page.

Author(s)

Markus Gesmann [e-mail],

Diego de Castillo [e-mail]

References

Google Scatter Chart API: http://code.google.com/apis/chart/interactive/docs/gallery/scatterchart.html

Follow the link for Google's data policy.

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.


## Scatter chart
Scatter1 <- gvisScatterChart(women)
plot(Scatter1)

## Using optional arguments
Scatter2 <- gvisScatterChart(women, options=list(legend="none",
                 lineWidth=2, pointSize=0,
                 title="Women", vAxis="{title:'weight (lbs)'}",
                 hAxis="{title:'height (in)'}", width=300, height=300))
                 
plot(Scatter2)


df=data.frame(x=sin(1:100/3), 
              Circle=cos(1:100/3), 
 	      Ellipse=cos(1:100/3)*0.5)

## Plot several variables as smooth curves
Scatter3 <- gvisScatterChart(df, 
	    		options=list(curveType='function', 
				     pointSize=0, 
				     lineWidth=2))
plot(Scatter3)

kleanthisk10/google-motion-charts-with-r documentation built on May 20, 2019, 12:32 p.m.