create_qmd: Creation and rendering of QMD graphs

View source: R/create_qmd.R

create_qmdR Documentation

Creation and rendering of QMD graphs

Description

Creates a QMD graph using data.frames for comp and arrow.

Usage

create_qmd(comp = NULL, arrow = NULL, pbpk = NULL, graph_attrs = NULL,
  flipped = FALSE, title = NULL, save_qmd = FALSE, file_name = NULL,
  format = "svg", width = NULL, height = NULL)

Arguments

comp

a data.frame created by define_comp_layout

arrow

a data.frame created by define_arrow_layout

pbpk

a list created by define_pbpk_layout

graph_attrs

an optional data.frame of graph attribute statements that can serve as defaults for the graph. The data.frame must contain the "attr", "value" and "type" columns. (e.g. data.frame(attr = "layout", value = "dot", type = "graph")

flipped

logical if TRUE the layout will be flipped

title

a title to be added to the graph

save_qmd

save the graph into a file (default FALSE)

file_name

name of the file to be created on the disk when save_qmd is TRUE

format

file format when save_qmd is TRUE. Must be one of "png", "pdf", "svg" or "ps"

width

width of the resulting graphic in pixels

height

height of the resulting graphic in pixels

Examples

## Not run: 
define_graph(comp  = define_comp_layout(examples$onecomp),
             arrow = define_arrow_layout(examples$onecomp))

## End(Not run)

guiastrennec/modelviz documentation built on Feb. 16, 2024, 8:14 p.m.