gvisWordTree: Google Word Tree with R \Sexpr{googleChartName <- "wordtree"}...

View source: R/gvisWordTree.R

gvisWordTreeR Documentation

Google Word Tree with R \Sexpr{googleChartName <- "wordtree"} \Sexpr{gvisChartName <- "gvisWordTree"}

Description

A word tree depicts multiple parallel sequences of words. It could be used to show which words most often follow or precede a target word (e.g., "Cats are...") or to show a hierarchy of terms (e.g., a decision tree).

Usage

gvisWordTree(
  data,
  textvar = "",
  sizevar = "",
  stylevar = "",
  idvar = "",
  parentvar = "",
  options = list(),
  method = "implicit",
  chartid
)

Arguments

data

data.frame that contains the data to be visualised

textvar

a string that refers to the column name in data that contains the text to be used.

sizevar

a string that refers to the column name in data that contains the size of the words in the word tree.

stylevar

a string that refers to the column name in data that contains the stlye of the text. For no warning message in plot, should be called <textvar>.style.

idvar

(only when format is explicit) a string that refers to the column name in data that contains the unique ID of the text.

parentvar

(only when format is explicit) a string that refers to the column name in data that contains the ID of the parent of the text.

options

list of configuration options, see:

\Sexpr[results=rd]{gsub("CHARTNAME", googleChartName, readLines(file.path(".", "inst", "mansections", "GoogleChartToolsURLConfigOptions.txt")))} \Sexpr[results=rd]{paste(readLines(file.path(".", "inst", "mansections", "gvisOptions.txt")))}
method

a string to say whether the word tree is either:

  • implicit - will weight and connect automatically, or

  • explicit - can specify weights and connections

chartid

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

Value

\Sexpr[results=rd]{paste(gvisChartName)}

returns list of class \Sexpr[results=rd]{paste(readLines(file.path(".", "inst", "mansections", "gvisOutputStructure.txt")))}

Warning

The word tree chart may be undergoing substantial revisions in future Google Charts releases.

Author(s)

Ashley Baldry

References

Google Chart Tools API: \Sexpr[results=rd]{gsub("CHARTNAME", googleChartName, readLines(file.path(".", "inst", "mansections", "GoogleChartToolsURL.txt")))}

Examples

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

wt1 <- gvisWordTree(Cats, textvar = "Phrase")
plot(wt1)

Cats2 <- Cats
Cats2$Phrase.style <- ifelse(Cats$Sentiment >= 7, "green", 
                             ifelse(Cats$Sentiment <= 3, "red", "black"))
                             
wt2 <- gvisWordTree(Cats2, textvar = "Phrase", stylevar = "Phrase.style",
                    options = list(fontName = "Times-Roman",
                                   wordtree = "{word: 'cats'}",
                                   backgroundColor = "#cba"))
plot(wt2)

# Explicit word tree
exp.data <- data.frame(id = as.numeric(0:9),
                       label = letters[1:10],
                       parent = c(-1, 0, 0, 0, 2, 2, 4, 6, 1, 7),
                       size = c(10, 5, 3, 2, 2, 2, 1, 1, 5, 1),
                       stringsAsFactors = FALSE)

wt3 <- gvisWordTree(exp.data, idvar = "id", textvar = "label", 
                    parentvar = "parent", sizevar = "size",
                    options = list(wordtree = "{format: 'explicit'}"),
                    method = "explicit")
plot(wt3)


googleVis documentation built on March 7, 2023, 7:40 p.m.