Package index • ggpaintr

L1 — All-in-one

Turn a ggplot-style formula into a ready-to-run Shiny app with one call to ptr_app().

ptr_app(): Build a Shiny App from a ggpaintr Formula

RStudio addin

Wrap a highlighted selection in a placeholder from the RStudio command palette.

ptr_wrap_placeholder_addin(): RStudio addin: wrap a selection in a ggpaintr placeholder

Formula placeholders

The pp* tokens you write inside a formula — the value/consumer/source controls plus the structural toggles.

ppVar() ppNum() ppText() ppExpr() ppUpload(): Placeholder Identity Helpers
ppLayerOff(): Off-by-default layer wrapper
ppVerbSwitch(): Switchable pipeline-stage wrapper

Session configuration

Process-wide defaults, column-name normalisation, and UI copy overrides.

ptr_options(): Get or Set ggpaintr Package Options
ptr_normalize_column_names(): Normalize Dataset Column Names for ggpaintr
ptr_ui_text(): Inspect, validate, and pre-merge ggpaintr UI copy

L2 — Embed with the default layout

Plug ggpaintr into your own Shiny app with its self-contained default layout. The module pair is the L2 entry; the shared coordinator (ptr_shared() → ptr_shared_panel() + ptr_shared_server()) links a cross-formula key across plots. See vignette("ggpaintr-tutorial") § “Multiple plots, and writing your own Shiny app”.

ptr_ui(): Self-contained UI for a ggpaintr Formula
ptr_server(): Server for a ggpaintr Formula
ptr_shared(): Build the Shared Coordinator for a Multi-Instance Embedding
ptr_shared_panel(): Render the Standalone Shared Panel (L2, Self-Contained)
ptr_shared_server(): Server-Side Counterpart to the Shared Coordinator

L3 — Own the layout / render path

Own every piece of ggpaintr’s public UI — bare builders (no behaviour flags) plus nestable combinators. Compose freely under your own Shiny (optionally ptr_ui_page()) and wire with ptr_server(). See vignette("ggpaintr-tutorial").

ptr_ui_page(): Page shell for hand-composed ggpaintr UIs
ptr_ui_header(): App Header Piece for ggpaintr
ptr_ui_controls(): Controls Piece for a ggpaintr Formula
ptr_ui_plot(): Plot Pane Piece for a ggpaintr Formula
ptr_ui_error(): Inline Error Pane Piece for a ggpaintr Formula
ptr_ui_code(): Generated-Code Pane Piece for a ggpaintr Formula
ptr_ui_shared_panel(): Render the Standalone Shared Panel (L3, Bare)
ptr_ui_inline_error(): Nest an Inline Error Slot in a Plot Piece
ptr_ui_toggle_code(): Wire a Plot-ish Piece to a Slide-Out Code Window via the </> Toggle
ptr_ui_assets(): Bundled CSS / JS Assets Piece for ggpaintr

Linked selection (plotly)

L3 custom-render helpers that turn a drawn ggpaintr plot into an interactive plotly widget and read its brushed selection back as data. See ptr_server(), section “Custom render (L3)”.

ptr_ggplotly(): Build a plotly Widget From a ggpaintr Instance, Wired for Linked Selection
ptr_plotly_selection(): Read a ptr_ggplotly() Linked Selection As Rows or a Flag Column

Advanced embedders

Drive the typed tree programmatically or read runtime outputs off the returned state.

ptr_init_state(): Construct the ggpaintr runtime state container
ptr_extract_plot() ptr_extract_error() ptr_extract_code(): Extract Runtime Outputs From a ptr_state
ptr_gg_extra(): Add ggplot2 Layers Programmatically
ptr_resolve_ui_text(): Resolve copy for one ggpaintr control or app element
ptr_id_table(): Enumerate every Shiny id a ggpaintr formula produces

Placeholder authors

Register supported custom placeholder types and their UI hooks without editing package internals.

ptr_define_placeholder_value(): Define a value placeholder
ptr_define_placeholder_consumer(): Define a data-consumer placeholder (e.g. column picker)
ptr_define_placeholder_source(): Define a data-source placeholder (e.g. upload, database table)
ptr_clear_placeholder(): Remove user-registered placeholders
build_ui_for(): Build a Shiny UI Widget for a Typed-Tree Node
ptr_arg_symbol_or_string() ptr_arg_string() ptr_arg_symbol() ptr_arg_numeric() ptr_arg_expression(): Argument validators for placeholder definitions (ptr_arg_*)
embellish_identity() embellish_symbol_to_string(): Built-in helpers for a placeholder's plain-R evaluation slot
ptr_register_constant_fold() ptr_clear_constant_fold() ptr_constant_fold_keywords(): Constant-fold allowlist registry
ptr_signal_partial(): Signal a transient "partial input" failure from a placeholder hook

LLM tooling

Expose ggpaintr’s documentation bundle to ellmer-backed coding assistants.

ptr_llm_primer(): Get the ggpaintr LLM system-prompt primer
ptr_llm_topic(): Fetch a ggpaintr LLM topic
ptr_llm_topics(): List available ggpaintr LLM topic names
ptr_llm_register(): Register ggpaintr with an ellmer chat session