Function reference • trelliscope

Create a Trelliscope data frame

as_trelliscope_df(): Instantiate a trelliscope data frame

Panel visualization specification

panel_local(): Add a "panel_local" column to a dataset

panel_lazy(): Add a "calculated panel" column to a dataset

panel_url(): Add a "panel_url" column to a dataset

facet_panels(): Add a trelliscope facet to a ggplot

as_panels_df(): Render the panels of a trelliscope display

panel_options(): Specify options for lazily-rendered panels in a Trelliscope display

Meta variables

Special meta variable types beyond the basic R types

number(): Create a number vector

currency(): Create a currency vector

href(): Create a vector of links

filter_cat_href(): Create a link to another display filtered to categories of a variable

Pipe functions

These functions receive and return a modified trelliscope data frame

set_tags(): Set tags for variables in a data frame

set_var_labels(): Set labels for variables in a data frame

set_panel_options(): Set panel options for a Trelliscope display

set_primary_panel(): Set the primary panel of a trelliscope display

set_default_filters(): Add a filter state specifications to a trelliscope display

set_default_labels(): Add a labels state specification to a trelliscope display

set_default_layout(): Add a layout state specification to a trelliscope display

set_default_sort(): Add a labels state specification to a trelliscope display

add_inputs(): Add inputs to a trelliscope display

add_view(): Add a view specification to a trelliscope display

set_info_html(): Specify custom "display info" html

set_theme(): Set a color theme for a Trelliscope display

set_show_info_on_load(): Show "display info" when display first loads

add_charm(): Use fidelius to password protect a trelliscope display

write_trelliscope(): Write the contents of a display

view_trelliscope(): View a trelliscope display

Inputs

Specify panel-level user inputs

input_checkbox(): Specify a "checkbox" input

input_multiselect(): Specify a "multiselect" input

input_number(): Specify a "numeric" input box

input_radio(): Specify a "radio button" input

input_select(): Specify a "select" input

input_text(): Specify a "text box" input

State specification

Specify states to be used in default and custom views

filter_range(): Specify a range "filter" state (applies to numeric, date, and datetime meta variables)

filter_string(): Specify a string "filter" state (applies to string and factor meta variables)

state_labels(): Specify a "labels" state

state_layout(): Specify a "layout" state

state_sort(): Specify a "sort" state

Miscellanious utilities

show_info(): View trelliscope info of a trelliscope data frame

as_json(): Convert any trelliscope R6 object to JSON

update_display_list(): Update the list of all displays in an app directory

currencies: Data frame of currencies and their codes

Embedding

trelliscopeOutput() renderTrelliscope(): Shiny bindings for trelliscope

add_trelliscope_resource_path(): Add Trelliscope resource path for Shiny app

Example datasets

gap: Gapminder data with ISO codes and country centroids

mars_rover: Mars rover data