Skip to contents

Primary functions

Core functions used to generate figures.

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

Backends

Backend engines used to build figures.

list_backends()
List Registered Backends
register_backend()
Register a Rendering Backend

Geoms

Main

All highdir plots begin with a call to hd(), supply with either hd_spec() or directly defined in hd(). You then add geoms and options with +. To save a plot to disk, use hd_save().

hd()
Initialise a Composable highdir Figure
`+`(<hd>)
Add Layers to an hd Object

Types

Geom types

hd_geom_arearange()
Add an Arearange (Confidence Band) Layer
hd_geom_column()
Column Geometry Layer for hd Objects
hd_geom_line() hd_geom_scatter() hd_geom_pie() hd_geom_ranked_bar()
Geometry Layers for hd Objects
hd_geom_stacked_column()
Stacked Column Geometry Layer

Helpers

Geometric layers and related functions used to construct figures.

list_geoms()
List Registered Geometries
geom_args()
Show Arguments for a Geometry
register_geom()
Register a Geometry
print(<hd>)
Render an hd Object

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

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