Package index

Dashboard Creation

Functions for creating and managing dashboards

create_dashboard(): Create a new dashboard project
add_dashboard_page(): Add a page to the dashboard
add_page(): Add Page to Dashboard (Alias)
add_pages(): Add multiple pages to a dashboard
create_page(): Create a page object
add_content(): Add content collection to a page
generate_dashboard(): Generate all dashboard files
generate_dashboards(): Process visualizations into organized specs with tab groups
publish_dashboard(): Publish dashboard to GitHub Pages
update_dashboard(): Update dashboard on GitHub
create_loading_overlay(): Create a loading overlay for a dashboard page
create_pagination_nav(): Create pagination navigation controls for a dashboard page
add_powered_by_dashboardr(): Add "Powered by dashboardr" branding to footer

Demo Dashboards

Built-in demo dashboards showcasing package features

tutorial_dashboard(): Generate a tutorial dashboard.
showcase_dashboard(): Generate a showcase dashboard demonstrating all dashboardr features.
ascor_dashboard(): Generate an ASCoR-themed dashboard for the University of Amsterdam

Visualization Creation

Functions for creating visualizations

create_viz(): Create a new visualization collection
create_content(): Create a new content/visualization collection (alias for create_viz)
add_viz(): Parse tabgroup into normalized hierarchy
add_vizzes(): Add Multiple Visualizations at Once
combine_viz(): Combine visualization collections
combine_content(): Combine content collections (universal combiner)
merge_collections(): Merge two content/viz collections
add_pagination() add_pagination.page_object(): Create a sidebar group for hybrid navigation
set_tabgroup_labels(): Set or update tabgroup display labels
preview(): Preview any dashboardr object
save_widget(): Save widget as self-contained HTML
validate_specs(): Validate visualization specifications in a collection

Visualization Types

Functions for different chart types

viz_histogram(): Create an Histogram
viz_density(): Create a Density Plot
viz_boxplot(): Create a Box Plot
viz_bar(): Create Bar Chart
viz_stackedbar(): Create a Stacked Bar Chart
viz_stackedbars(): Stacked Bar Charts for Multiple Variables (Superseded)
viz_timeline(): Create a Timeline Chart
viz_heatmap(): Create a Heatmap
viz_scatter(): Create Scatter Plot
viz_map(): Create an interactive map visualization
viz_treemap(): Create a treemap visualization

Functions for customizing chart tooltips

tooltip(): Create a Tooltip Configuration
print(<dashboardr_tooltip>): Print method for tooltip configurations
add_hc(): Add a custom highcharter chart

Stacked Bar Charts

viz_stackedbar() is the unified function for all stacked bar charts. Use x_var + stack_var for crosstabs, or x_vars for multi-variable comparisons. viz_stackedbars() is a legacy wrapper that calls viz_stackedbar().

viz_stackedbar(): Create a Stacked Bar Chart
viz_stackedbars(): Stacked Bar Charts for Multiple Variables (Superseded)

Functions for dashboard navigation and structure

navbar_section(): Create a navbar section for hybrid navigation
navbar_menu(): Create a navbar dropdown menu
add_navbar_element(): Add a custom navbar element to dashboard
sidebar_group(): Create a sidebar group for hybrid navigation
icon(): Create iconify icon shortcode

Content Helpers

Functions for adding content to dashboards

md_text(): Create multi-line markdown text content
text_lines(): Create text content from a character vector
create_blockquote(): Create a Styled Blockquote
card(): Create a Bootstrap card component
card_row(): Display cards in a Bootstrap row
spec_viz(): Create a single visualization specification

Content Blocks

Functions for adding rich content blocks to pages

add_text(): Add text to content collection (pipeable)
add_image(): Add image to content collection (pipeable)
add_callout(): Add callout box
add_divider(): Add horizontal divider
add_code(): Add code block
add_card(): Add card
add_accordion(): Add collapsible accordion/details section
add_spacer(): Add vertical spacer
add_html(): Add raw HTML content
add_quote(): Add a blockquote
add_badge(): Add a status badge

Modals

Functions for adding interactive modal dialogs

add_modal(): Add Modal to Content Collection (Pipeable)
enable_modals(): Enable Modal Functionality
modal_content(): Create Modal Content Container
modal_link(): Create Modal Link

Metrics & Value Boxes

Functions for displaying KPIs and metrics

add_metric(): Add a metric/value box
add_value_box(): Add a custom styled value box
add_value_box_row(): Start a value box row
end_value_box_row(): End a value box row
render_value_box(): Render a single value box
render_value_box_row(): Render a row of value boxes

Interactive Inputs

Functions for adding interactive inputs to dashboards

add_input(): Add an interactive input filter
add_filter(): Add a filter control (simplified interface)
add_input_row(): Start an input row
add_reset_button(): Add a reset button to reset filters
enable_inputs(): Enable Input Filter Functionality
end_input_row(): End an input row
render_input(): Render an input widget
render_input_row(): Render a row of input widgets

Sidebars

Functions for adding page sidebars with filters

add_sidebar(): Add a sidebar to a page
end_sidebar(): End a sidebar
enable_sidebar(): Enable Sidebar Styling

Embedded Content

Functions for embedding external content

add_iframe(): Add iframe
add_video(): Add video

Tables

Functions for adding tables to pages

add_table(): Add generic table (data frame)
add_gt(): Add gt table
add_reactable(): Add reactable table
add_DT(): Add DT datatable

Themes & Styling

Functions for customizing dashboard appearance

apply_theme(): Apply Theme to Dashboard
theme_modern(): Apply a Modern Tech Theme to Dashboard
theme_clean(): Apply a Clean Theme to Dashboard
theme_academic(): Apply a Professional Academic Theme to Dashboard
theme_ascor(): Apply ASCoR/UvA Theme to Dashboard
theme_uva(): Apply UvA Theme to Dashboard (Alias)

Print Methods

S3 methods for displaying objects

print(<viz_collection>): Create a new dashboard project
print(<dashboard_project>): Create iconify icon shortcode
print(<page_object>): Print method for page objects
print(<dashboardr_widget>): Print method for dashboardr_widget - opens in viewer
knit_print(<content_collection>): Knitr print method for content collections
knit_print(<page_object>): Knitr print method for page objects
knit_print(<dashboard_project>): Knitr print method for dashboard projects
show_structure(): Show collection structure (even with data attached)
`+`(<viz_collection>): Combine viz collections using + operator
`+`(<content_collection>): Combine Content Collections with + Operator

Page Object Methods

S3 methods for page objects

add_text.page_object(): Add text to a page
add_callout.page_object(): Add a callout to a page
set_tabgroup_labels.page_object(): Set tabgroup labels for a page