Package index • maidr

Main functions

Primary user-facing functions for creating accessible plots

show(): Display Interactive MAIDR Plot
save_html(): Save Interactive Plot as HTML File

Interactive htmlwidgets

Charts drawn by plotly, highcharter and echarts4r, read by the MAIDR JavaScript adapter for the library that draws them

maidr_htmlwidget(): Make a plotly, highcharter or echarts4r htmlwidget accessible

Declaring what a layer means

Functions an author adds to a plot to say what a layer is, where the picture alone cannot say it

maidr_gantt(): Declare that a rectangle layer draws a schedule
maidr_roc(): Declare that a path layer draws a ROC curve

Turning interception on and off

Interception is on after library(maidr): printing a ggplot2 or lattice chart opens the viewer and Base R calls are recorded until show(). In an R Markdown or Quarto document, library(maidr) makes every plot an accessible chart in the page. maidr_off() and maidr_on() turn it off and on again; the options turn parts of it off.

maidr_on(): Enable MAIDR Plot Interception
maidr_off(): Disable MAIDR Plot Interception
maidr-options: MAIDR Package Options

What attaching maidr masks

The Base R plotting functions and methods::show(), each replaced on the search path by a wrapper that records the call and passes through to the original

barplot() plot() hist() boxplot() image() heatmap() contour() matplot() curve() dotchart() stripchart() stem() pie() mosaicplot() assocplot() pairs() coplot() persp() sunflowerplot() fourfoldplot() spineplot() cdplot() qqnorm() qqplot() qqline() filled.contour() acf() pacf() ccf() cpgram() spectrum() monthplot() termplot() lag.plot() biplot() interaction.plot() bxp() stars() vioplot() wordcloud() chartSeries() lines() points() text() mtext() abline() segments() arrows() polygon() rect() symbols() legend() axis() title() grid() par() layout() split(<screen>): Functions maidr masks on attach

Shiny integration

Functions for using maidr in Shiny applications

render_maidr(): Render MAIDR Plot in Shiny Server
maidr_output(): MAIDR Output Container for Shiny UI

Configuration and utilities

Functions for configuring MAIDR behavior and running examples

maidr_set_fallback(): Configure MAIDR Fallback Behavior
maidr_get_fallback(): Get Current MAIDR Fallback Settings
maidr_download_dotpad_sdk(): Download the DotPad SDK for use offline
run_example(): Run MAIDR Example Plots

Internal utilities

Internal functions for package developers

combine_facet_layer_data(): Combine data from multiple layers in facet processing
combine_facet_layer_selectors(): Combine selectors from multiple layers in facet processing
extract_leaf_plot_layout(): Extract layout from a single leaf ggplot
extract_patchwork_leaves(): Recursively extract leaf ggplots in patchwork addition order
find_children_by_type(): Find children matching a type pattern
find_graphics_plot_grob(): Find grob by element type pattern
find_patchwork_panels(): Discover panels via gtable layout rows named ^panel-<num> or ^panel-<row>-<col> Returns a data.frame with panel_index, name, t, l, row, col
generate_robust_css_selector(): Generate robust CSS selector from grob name
generate_robust_selector(): Generate robust selector for any element type
get_facet_groups(): Get facet group information for a panel
map_visual_to_dom_panel(): Map visual panel position to DOM panel name
organize_facet_grid(): Organize subplots into 2D grid structure
process_facet_panel(): Process a single facet panel
process_faceted_plot_data(): Process a faceted plot and return organized subplot data
process_patchwork_panel(): Process a single patchwork panel
process_patchwork_plot_data(): Process a patchwork plot and return organized subplot data