Google Org Chart with R orgchart gvisOrgChart

An organizational chart that supports selection.

Usage

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, see:

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

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

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.

Details

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.

References

Google Chart Tools API: https://developers.google.com/chart/interactive/docs/gallery/orgchart

Author

Markus Gesmann markus.gesmann@gmail.com,

Diego de Castillo decastillo@gmail.com

Examples


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

Regions
#>     Region  Parent Val Fac
#> 1   Global    <NA>  10   2
#> 2  America  Global   2   4
#> 3   Europe  Global  99  11
#> 4     Asia  Global  10   8
#> 5   France  Europe  71   2
#> 6   Sweden  Europe  89   3
#> 7  Germany  Europe  58  10
#> 8   Mexico America   2   9
#> 9      USA America  38  11
#> 10   China    Asia   5   1
#> 11   Japan    Asia  48  11
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)