CreateFlowchart: Create flowchart

Description Usage Arguments

View source: R/CreateFlowchart.R

Description

Generates flowchart using TikZ. Requires the xstring and tikz packages. Compiled with knitr (which in turn uses xelatex) or xelatex depending on file extension in flowchart.file.path.

Usage

1
2
3
4
5
CreateFlowchart(flowchart.elements = NULL, flowchart.font = NULL,
  flowchart.file.path = "./flowchart.tex", print.tikz = TRUE,
  save.tikz = TRUE, compile.flowchart = FALSE,
  train.test.split = FALSE, prettify = FALSE,
  read.from.results = TRUE, ...)

Arguments

flowchart.elements

Character vector. Content for nodes. Length must be > 1. Remember to escape e.g. underscores in the text. Defaults to NULL.

flowchart.font

Character vector of length 1. The font for flowchart nodes, e.g. LiberationSerif. Uses the mathspec package. Flowchart is compiled with XeLaTex or knitr depending on file extension in flowchart.file.path. Defaults to NULL.

flowchart.file.path

Character vector of length 1. The flowchart file path. Defaults to "./flowchart.tex".

print.tikz

Logical. If TRUE TikZ code is printed to console. Defaults to TRUE.

save.tikz

Logical. If TRUE TikZ code for flowchart is saved to disk. Defaults to TRUE.

compile.flowchart

Logical. If TRUE the flowchart is compiled using knitr or pdflatex, depending on the file format. Defaults to TRUE

train.test.split

Logical. If TRUE last two elements of flowchart list are interpreted as "train" and "test" texts, i.e. text explaining how many patients are grouped in train and test samples. Second to last element is displayed to the left and last element is displayed to the right. Defaults to FALSE.

prettify

Logical. If TRUE shadows are used for flowchart nodes. Requires TikZ package shadows.blur. Defaults to FALSE.

read.from.results

Logical. If TRUE flowchart.elements is read from results.Rds. Defaults to TRUE.

...

Additional arguments for system function.


martingerdin/bengaltiger documentation built on Feb. 29, 2020, 4:46 p.m.