Package index • highdir

Declarative API

Primary functions

Core functions used to generate figures. See the examples for practical usage.

hd_spec(): Create a Figure Data Specification
hd_make(): Build a Figure from a Specification

Secondary functions

Additional optional functions that support workflows.

hd_opts(): Create Figure Presentation Options
hd_save(): Save a Figure to Disk
hd_app(): Launch the highdir Shiny GUI

Layered API

Primary functions

All highdir plots start with a call to hd(), either using a specification created with hd_spec() or defined directly inside hd(). You then layer geoms and options using +. See the examples under each geom below for concrete usage patterns.

hd(): Initialise a Composable highdir Figure

Secondary functions

Geom types

hd_geom_arearange(): Add an Arearange (Confidence Band) Layer
hd_geom_column(): Column Geometry Layer for hd Objects
hd_geom_line(): Line Geometry Layer for hd Objects
hd_geom_pie(): Pie Geometry Layer for hd Objects
hd_geom_ranked_bar(): Ranked bar geometry
hd_geom_scatter(): Scatter Geometry Layer for hd Objects
hd_geom_stacked_column(): Stacked Column Geometry Layer

Backends

Backend engines used to build figures.

list_backends(): List Registered Backends
register_backend(): Register a Rendering Backend and used when loding in zzz.R file

Themes

Theme functions defining the visual style of figures.

hd_theme(): Build a Highcharts Theme Object
gg_theme(): Build a ggplot2 Theme Object
hd_set_theme(): Set Package-Wide Style Defaults
list_palettes(): List Registered Palettes
get_palette(): Retrieve a Named Palette
register_palette(): Register a Named Colour Palette

Helpers

Geometric layers and related functions used to construct figures.

`+`(<hd>): Add Layers to an hd Object
list_geoms(): List Registered Geometries
geom_args(): Show Arguments for a Geometry
register_geom(): Register a Geometry
print(<hd>): Render an hd Object

JavaScript

JavaScript-related utilities (relevant for Highcharts output).

hd_add_js(): Inject JavaScript into a Highcharts Widget

Datasets

Example datasets

alco1: Alcohol Consumption Data
alco2: Alcohol Consumption by Gender