prepare_design_flow_chart: Prepare A Flow Chart of Your Research Design

View source: R/prepare_design_flow_chart.R

prepare_design_flow_chartR Documentation

Prepare A Flow Chart of Your Research Design

Description

Generates a DiagrammeR flow chart of your research design. Output can be saved to a file or directly viewed.

Usage

prepare_design_flow_chart(
  d,
  file_name = NULL,
  landscape = FALSE,
  color_step = "skyblue2",
  color_dchoice = "skyblue3",
  color_cchoice = "skyblue4",
  color_result = "slategray"
)

Arguments

d

A character vector of the research design steps function names

file_name

A file name for an output PDF file relative to the working directory.

landscape

Do you want the flow chart to be generated horizontally instead of vertically. Defaults to FALSE.

color_step

The fill color to indicate a design step.

color_dchoice

The fill color to indicate a discrete choice.

color_cchoice

The fill color to indicate a continuous choice.

color_result

The fill color to indicate a result.

Value

the rendered diagram or, if file_name is specified, the return code from DiagrammeRsvg::export_graph()

Examples

## Not run: 
  print("Sorry. No examples yet.")

## End(Not run)

joachim-gassen/rdfanalysis documentation built on Aug. 22, 2023, 5:29 p.m.