Help for package ibmsunburst

Title:

Generate Personality Insights Sunburst Diagrams

Version:

0.1.4

Description:

Generates Personality Insights sunburst diagrams based on 'IBM Watson' Personality Insights service output.

License:

MIT + file LICENSE

URL:

https://github.com/jumpingrivers/ibmsunburst, https://jumpingrivers.github.io/ibmsunburst/

BugReports:

https://github.com/jumpingrivers/ibmsunburst/issues

Imports:

htmlwidgets, jsonlite

Suggests:

covr, knitr, rmarkdown, testthat

VignetteBuilder:

knitr

Encoding:

UTF-8

RoxygenNote:

7.2.1

NeedsCompilation:

Packaged:

2024-02-27 21:51:59 UTC; rhian

Author:

Colin Gillespie [aut, cre], Steph Locke

[aut], IBM [cph] (IBM is author of the original JS code.), Hendrik Feddersen [fnd] (https://www.ibm.com/), Kent Russell [aut], Maëlle Salmon

[ctb], Jumping Rivers [fnd]

Maintainer:

Colin Gillespie <colin@jumpingrivers.com>

Repository:

CRAN

Date/Publication:

2024-02-28 19:10:02 UTC

ibmsunburst.

Description

Produce an IBM Sunburst Diagram from a JSON data output from IBM Watson Personality Insights service

Usage

ibmsunburst(
  json = NULL,
  version = c("v2", "v3"),
  width = NULL,
  height = NULL,
  elementId = NULL
)

Arguments

json

list of data or data as JSON or path to file with data from IBM Watson Personality Insights service.

version

character version ('v2', 'v3') of Watson Personality Insights profile.

width

Desired width of widget in pixels

height

Desired height of widget in pixels

elementId

Name to assign to widget

Examples

json_path <- system.file(
  "extdata", "profiles",
  "en_v2.json", package = "ibmsunburst"
)

ibmsunburst(json = json_path, version = "v2")

Shiny bindings for ibmsunburst

Description

Output and render functions for using ibmsunburst within Shiny applications and interactive Rmd documents.

Usage

ibmsunburstOutput(outputId, width = "100%", height = "400px")

renderIbmsunburst(expr, env = parent.frame(), quoted = FALSE)

Arguments

outputId

output variable to read from

width, height

Must be a valid CSS unit (like '100%', '400px', 'auto') or a number, which will be coerced to a string and have 'px' appended.

expr

An expression that generates a ibmsunburst

env

The environment in which to evaluate expr.

quoted

Is expr a quoted expression (with quote())? This is useful if you want to save an expression in a variable.

Value

A htmlwidget of the sunburst