Package index

Core

Main R6 class used to parse .twb/.twbx workbooks.

Page-centric helpers and summaries; work with TwbParser or xml2 documents.

twb_pages(): List all pages (dashboards, worksheets, stories).
twb_pages_summary(): Summary of all pages (counts and quick descriptors).
twb_page_composition(): Show what a specific page is composed of.
twb_dashboards(): Dashboards overview (count of zones and referenced worksheets).
twb_dashboard_filters(): Filters found on dashboards and their positions.
twb_charts(): Chart (mark) types per worksheet.
twb_colors(): Colors and palettes referenced in the workbook.
twb_dashboard_summary(): Per-dashboard summary (filters count and chart types).

Per-worksheet shelf, filter, axis, and sort details.

twb_sheet_shelves(): Extract field-to-shelf assignments for worksheets
twb_sheet_filters(): Extract detailed filter configuration for worksheets
twb_sheet_axes(): Extract axis configuration for worksheets
twb_sheet_sorts(): Extract sort configuration for worksheets
twb_sheet_spec() twb_dashboard_charts(): Worksheet visualization specs and dashboard chart inventories

Per-dashboard zone layout, sheet positions, and actions.

twb_dashboard_sheets(): List worksheets embedded in each dashboard
twb_dashboard_size(): Dashboard page size and sizing mode
twb_dashboard_layout(): Full layout of dashboard zones with container hierarchy
twb_dashboard_actions(): Extract dashboard and workbook actions
twb_sheet_spec() twb_dashboard_charts(): Worksheet visualization specs and dashboard chart inventories

twbx_list(): List contents of a Tableau .twbx
extract_twb_from_twbx(): Extract the .twb (and optionally all files) from a .twbx
twbx_extract_files(): Extract specific files from a .twbx

extract_named_connections(): Extract <named-connection> entries from a TWB
extract_datasource_details(): Extract datasource details from a Tableau TWB
extract_raw_fields(): Extract non-calculated, non-parameter fields from a TWB
extract_columns_with_table_source(): Extract columns with their source tables from a TWB
extract_calculated_fields(): Extract calculated fields from a TWB
extract_parameters(): Extract parameter fields from a TWB
extract_relations(): Extract all <relation> tags from a TWB
extract_joins(): Extract Tableau join clauses from <relation type="join"> nodes
extract_relationships(): Extract modern relationships from a Tableau TWB
twb_initial_sql(): Extract Initial SQL statements from Tableau connections
twb_custom_sql(): Extract Custom SQL relations from a Tableau workbook
twb_published_refs(): Detect references to published data sources

infer_implicit_relationships(): Infer implicit relationships between tables from field metadata
validate_relationships(): Validate relationships against available datasources and fields

twb_lineage(): Build workbook lineage for migration analysis
build_dependency_graph(): Build a field dependency graph from calculated fields
plot_dependency_graph(): Plot a field dependency graph
plot_relationship_graph(): Plot a field-level relationship DAG (legacy)
plot_source_join_graph(): Plot a source join graph

Audit workbook portfolios, assess target compatibility, translate calculations, and generate migration deliverables and starter apps.

twb_calc_complexity(): Classify calculated fields by complexity
twb_field_usage(): Field usage matrix across worksheets
twb_replication_brief(): Replication brief for a Tableau workbook or dashboard

Answer “what do I need to recreate?” when rebuilding a workbook in another tool: unused fields, calculation build order, parameter usage.

tableau_formula_pretty(): Prettify a Tableau calculation formula for display
prettify_calculated_fields(): Add a prettified formula column to calculated fields table
twb_formatting(): Formatting rules (fonts, colours, number formats, …)
twb_tooltips(): Worksheet tooltips