gvisOrgChart: Google Org Chart with R

Description Usage Arguments Value Author(s) References See Also Examples

Description

An organizational chart that supports selection.

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

Usage

1
2
gvisOrgChart(data, idvar = "", parentvar = "", tipvar = "",
             options = list(), chartid)

Arguments

data

a data.frame. The data has to have at least three columns. Each row in the data table describes one node (a rectangle in the graph). Each node (except the root node) has one or more parent nodes. Each node is sized and colored according to its values relative to the other nodes currently shown.

idvar

column name of data describing the ID for each node. It should be unique among all nodes, and can include any characters, including spaces. This is shown on the node. You can specify a formatted value to show on the chart instead, but the unformatted value is still used as the ID.

parentvar

column name of data that match to entries in idvar. If this is a root node, leave this NA. Only one root is allowed.

tipvar

column name of data for the tip variable. Tool-tip text to show, when a user hovers over this node.

options

list of configuration options for Google Org 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/orgchart.html#Configuration_Options:

allowCollapse

Boolean. Default FALSE. Determines if double click will collapse a node.

allowHtml

Boolean. Default FALSE. If set to TRUE, names that includes HTML tags will be rendered as HTML.

nodeClass

A string. Default default class name. A class name to assign to node elements. Apply CSS to this class name to specify colors or styles for the chart elements.

selectedNodeClass

A string. Default class name. A class name to assign to selected node elements. Apply CSS to this class name to specify colors or styles for selected chart elements.

chartid

character. If missing (default) a random chart id will be generated based on chart type and tempfile

Value

gvisOrgChart 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 'OrgChart'

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.

Author(s)

Markus Gesmann markus.gesmann@gmail.com,

Diego de Castillo decastillo@gmail.com

References

Google Org Chart API: https://google-developers.appspot.com/chart/interactive/docs/gallery/orgchart.html

Follow the link for Google's data policy.

See Also

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

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
## Please note that by default the googleVis plot command
## will open a browser window and requires Internet
## connection to display the visualisation.

Regions
Org1 <- gvisOrgChart(Regions, idvar = "Region", parentvar = "Parent", 
     			      tipvar="Val")
plot(Org1)

## Set a few options
Org2 <- gvisOrgChart(Regions, idvar = "Region", parentvar = "Parent", 
     			      tipvar="Val", 
     		     options=list(width=600, height=400,
                     	          size='large', allowCollapse=TRUE))
plot(Org2)

jburos/GoogleVis documentation built on May 18, 2019, 9:19 p.m.