Draw a diagram of the data model

dm_draw() draws a diagram, a visual representation of the data model.

Usage

dm_draw(
  dm,
  rankdir = "LR",
  ...,
  col_attr = NULL,
  view_type = c("keys_only", "all", "title_only"),
  column_types = NULL,
  backend = c("DiagrammeR"),
  backend_opts = list(),
  columnArrows = lifecycle::deprecated(),
  graph_attrs = lifecycle::deprecated(),
  node_attrs = lifecycle::deprecated(),
  edge_attrs = lifecycle::deprecated(),
  focus = lifecycle::deprecated(),
  graph_name = lifecycle::deprecated(),
  font_size = lifecycle::deprecated()
)

Arguments

dm

A dm object.

rankdir

Graph attribute for direction (e.g., 'BT' = bottom –> top).

...

These dots are for future extensions and must be empty.

col_attr

Deprecated, use colummn_types instead.

view_type

Can be "keys_only" (default), "all" or "title_only". It defines the level of details for rendering tables (only primary and foreign keys, all columns, or no columns).

column_types

Set to TRUE to show column types.

backend

Currently, only the default "DiagrammeR" is accepted. Pass this value explicitly if your code relies on the type of the return value.

backend_opts

A named list of backend-specific options. For the "DiagrammeR" backend, supported options are:

• graph_attrs: Additional graph attributes (default "").

• node_attrs: Additional node attributes (default "").

• edge_attrs: Additional edge attributes (default "").

• focus: A list of parameters for rendering (table filter).

• graph_name: The name of the graph (default "Data Model").

• column_arrow: Edges from columns to columns (default TRUE).

• font_size: Font size for header (default 16), column (default 16), and table_description (default 8). Can be set as a named integer vector, e.g. c(table_headers = 18L, table_description = 6L).

columnArrows

Use backend_opts = list(column_arrow = ...) instead.

graph_attrs

Use backend_opts = list(graph_attrs = ...) instead.

node_attrs

Use backend_opts = list(node_attrs = ...) instead.

edge_attrs

Use backend_opts = list(edge_attrs = ...) instead.

focus

Use backend_opts = list(focus = ...) instead.

graph_name

Use backend_opts = list(graph_name = ...) instead.

font_size

Use backend_opts = list(font_size = ...) instead.

Value

An object with a print() method, which, when printed, produces the output seen in the viewer as a side effect. Currently, this is an object of class grViz (see also DiagrammeR::grViz()), but this is subject to change.

Details

Currently, dm uses DiagrammeR to draw diagrams. Use DiagrammeRsvg::export_svg() to convert the diagram to an SVG file.

The backend for drawing the diagrams might change in the future. If you rely on DiagrammeR, pass an explicit value for the backend argument.

See also

dm_set_colors() for defining the table colors.

dm_set_table_description() for adding details to one or more tables in the diagram

Examples

dm_nycflights13() %>%
  dm_draw()

dm_nycflights13(cycle = TRUE) %>%
  dm_draw(view_type = "title_only")

head(dm_get_available_colors())
#> [1] "default"       "white"         "aliceblue"     "antiquewhite" 
#> [5] "antiquewhite1" "antiquewhite2"
length(dm_get_available_colors())
#> [1] 658

dm_nycflights13() %>%
  dm_get_colors()
#>  #ED7D31FF  #ED7D31FF  #5B9BD5FF  #ED7D31FF  #70AD47FF 
#> "airlines" "airports"  "flights"   "planes"  "weather"