vignettes/model2_diagram_code.R

In andreashandel/modeldiagram: Easy Creation of ggplot2 Based Figures of Flow Diagrams

## load libraries ----
library(ggplot2)
library(flowdiagramr)


variables <- data.frame(
  id = 1:7,
  name = c("Sc", "Ic", "Rc", "Sa", "Ia", "Ra", "P"),
  xmin = c(1, 8, 11.5, 1, 8, 11.5, 4.5),
  xmax = c(3, 10, 13.5, 3, 10, 13.5, 6.5),
  ymin = c(4, 4, 4, 0, 0, 0, 2),
  ymax = c(5, 5, 5, 1, 1, 1, 3),
  xlabel = c(2, 9, 12.5, 2, 9, 12.5, 5.5),
  ylabel = c(4.5, 4.5, 4.5, 0.5, 0.5, 0.5, 2.5),
  outline_color = c("#031e79", "#031e79", "#031e79", "#031e79", "#031e79", "#031e79", "#031e79"),
  fill_color = c("#cde9fa", "#cde9fa", "#cde9fa", "#40f9cf", "#40f9cf", "#40f9cf", "#b2b2b2"),
  label_text = c("Sc", "Ic", "Rc", "Sa", "Ia", "Ra", "P"),
  label_color = c("black", "black", "black", "black", "black", "black", "black"),
  label_size = c(4, 4, 4, 4, 4, 4, 4)
)

flows <- data.frame(
  name = c("e_dP", "g_raIa", "g_rcIc", "i_baaSaIa", "i_bacSaIc", "i_bapSaP", "i_bcaScIa", "i_bccScIc", "i_bcpScP", "m_bacSaIc_m_baaSaIa_m_bapSaP", "m_bccScIc_m_bcaScIa_m_bcpScP", "m_gaIa", "m_gcIc"),
  type = c("external", "generator", "generator", "interaction", "interaction", "interaction", "interaction", "interaction", "interaction", "main", "main", "main", "main"),
  id = c(7L, 6L, 5L, 12L, 11L, 13L, 9L, 8L, 10L, 4L, 3L, 2L, 1L),
  from = c("P", "Ia", "Ic", "Ia", "Ic", "P", "Ia", "Ic", "P", "Sa", "Sc", "Ia", "Ic"),
  to = c(NA, "P", "P", NA, NA, NA, NA, NA, NA, "Ia", "Ic", "Ra", "Rc"),
  xstart = c(5.5, 8, 8, 9, 9, 4.5, 9, 9, 4.5, 3, 3, 10, 10),
  xend = c(6.5, 6.5, 6.5, 5.5, 5.5, 5.5, 5.5, 5.5, 5.5, 8, 8, 11.5, 11.5),
  ystart = c(2, 0.5, 4.5, -0.1, 3.9, 2.5, 1, 5.1, 2.5, 0.5, 4.5, 0.5, 4.5),
  yend = c(1.5, 2.5, 2.5, 0.5, 0.5, 0.5, 4.5, 4.5, 4.5, 0.5, 4.5, 0.5, 4.5),
  xlabel = c(6.2, 7.4, 7.4, 7.125, 9.675, 3.395, 9.475, 7.125, 3.795, 5.5, 5.5, 10.75, 10.75),
  ylabel = c(1.25, 2.1, 2.85, -0.324999999999999, 3.675, 1.75, 1.675, 5.325, 3.75, 0.6, 4.6, 0.85, 4.85),
  curvature = c(0, 0, 0, -0.5, -0.3, 0.7, 0.3, 0.5, -0.5, 0, 0, 0, 0),
  line_color = c("grey25", "grey25", "grey25", "#40f9cf", "#cde9fa", "orange", "#40f9cf", "#cde9fa", "orange", "grey25", "grey25", "grey25", "grey25"),
  line_size = c(1.1, 1.1, 1.1, 1.1, 1.1, 1.1, 1.1, 1.1, 1.1, 1.1, 1.1, 1.1, 1.1),
  line_type = c("dotted", "longdash", "longdash", "longdash", "longdash", "longdash", "longdash", "longdash", "longdash", "solid", "solid", "solid", "solid"),
  label_text = c("d*P", "ra*Ia", "rc*Ic", "baa*Sa*Ia", "bac*Sa*Ic", "bap*Sa*P", "bca*Sc*Ia", "bcc*Sc*Ic", "bcp*Sc*P", "", "", "ga*Ia", "gc*Ic"),
  label_color = c("black", "black", "black", "black", "black", "black", "black", "black", "black", "black", "black", "black", "black"),
  label_size = c(4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4),
  show_label = c(TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE),
  arrow_size = c(0.25, 0.25, 0.25, 0.25, 0.25, 0.25, 0.25, 0.25, 0.25, 0.25, 0.25, 0.25, 0.25),
  show_arrow = c(TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE)
)


 ## ggplot2 code ----
###
# make the diagram with ggplot2
###
# Start with an empty ggplot2 canvas. The coord_equal function ensures
# that the x and y coordinates are displayed in equal proportions to
# on another (that is, it makes sure that the squares look like squares).
# All layers are added sequentially onto this blank canvas.
diagram_plot <- ggplot() +
  coord_equal(clip = "off")


# LAYER 1: STATE VARIABLES
# plot the states variable nodes as rectangles

# The variables data frame is used to create rectangles, with size determined
# by the xmin, xmax, ymin, and ymax values in the nodes data frame. The
# outline color of the rectangles is defined by var_outline_color; the
# inside color (fill) of the rectangles is defined by var_fill_color.
# The color variables can be a single value or a vector, giving different
# colors to different rectangles/nodes/state variables. If a vector, the
# color and fill vectors must have a length that is equal to the number
# of rows in the nodes data frame (one value for each row).

# create the nodes/boxes/variables
# these are just empty rectangles with no text
for(i in 1:nrow(variables)) {
  diagram_plot <- diagram_plot +  # add new stuff to blank canvas
    geom_rect(
      data = variables[i, ],  # one row of the data frame
      aes(xmin = xmin, xmax = xmax, ymin = ymin, ymax = ymax),  # location information
      color = variables[i, "outline_color"],  # border color
      fill = variables[i, "fill_color"]  # internal, fill color
    )
}

# add label text, which goes on top of boxes based on location information
for(i in 1:nrow(variables)) {
  diagram_plot <- diagram_plot +  # add text to boxes
    geom_text(
      data = variables[i, ],
      aes(x = xlabel, y = ylabel, label = label_text),
      size = variables[i, "label_size"],
      color = variables[i, "label_color"]
    )
}

## add in all the flows
# start with the lines/arrows
for(i in 1:nrow(flows)) {
  if(flows[i, "show_arrow"] == TRUE) {
    diagram_plot <- diagram_plot +  # add the lines to the plot with boxes
      geom_curve(  # always use geom_curve, which is straight when cuvature = 1
        data = flows[i, ],
        aes(x = xstart,
            y = ystart,
            xend = xend,
            yend = yend),
        linetype = flows[i, "line_type"],
        arrow = arrow(length = unit(flows[i, "arrow_size"],"cm"), type = "closed"),
        color = flows[i, "line_color"],
        arrow.fill = flows[i, "line_color"],
        lineend = "round",
        size = flows[i, "line_size"],
        curvature = flows[i, "curvature"],
        ncp = 1000  # controls smoothness of curve, larger number = more smooth
      )
  }
}

for(i in 1:nrow(flows)) {
  if(flows[i, "show_label"] == TRUE) {
    diagram_plot <- diagram_plot +  # now add the flow labels to the canvas
      geom_text(
        data = flows[i, ],
        aes(x = xlabel, y = ylabel, label = label_text),
        size = flows[i, "label_size"],
        color = flows[i, "label_color"])
  }
}

# If with_grid == FALSE (default) then void out the theme
# otherwise keep the grey background with grid
# the grid can be useful for updating positions of items
with_grid <- FALSE  # default is false
if(with_grid == FALSE) {
  diagram_plot <- diagram_plot +
    theme_void()  # makes an empty plot theme with no axes, grids, or ticks
} else {
  # The else here may seem silly, but otherwise the returned plot is NULL
  diagram_plot <- diagram_plot  # just returns default ggplot2 theme
}
  


# These lines plot or save the generated diagram. 
# Uncomment them if you want to perform either action. 
# plot(diagram_plot) 
# ggsave('diagram_plot.png',diagram_plot)