Generate REDCap Project Diagram

Generates a diagram of the REDCap project structure based on the project object.

Usage

REDCap_diagram(
  project,
  static = FALSE,
  render = TRUE,
  duplicate_forms = TRUE,
  clean_names = TRUE,
  include_fields = FALSE,
  include_choices = FALSE,
  hierarchical = FALSE,
  direction = "LR",
  zoomView = TRUE
)

Arguments

project

project object from REDCapSync package

static

Logical (TRUE/FALSE). If TRUE, generates a static diagram with DiagrammeR. If FALSE, generates an interactive diagram with visNetwork. Default is FALSE.

render

Logical (TRUE/FALSE). If TRUE, renders the diagram. Default is TRUE.

duplicate_forms

Logical (TRUE/FALSE). If TRUE, includes duplicate form nodes in the diagram. Default is TRUE.

clean_names

Logical (TRUE/FALSE). If TRUE, cleans the names of the forms and fields in the diagram. Default is TRUE.

include_fields

Logical (TRUE/FALSE). If TRUE, includes fields in the diagram. Default is FALSE.

include_choices

Logical (TRUE/FALSE). If TRUE, includes choices in the diagram. Default is FALSE.

hierarchical

: Boolean. Default to false. When true, the layout engine positions the nodes in a hierarchical fashion using default settings. For customization you can use visHierarchicalLayout

direction

: String. Default to 'UD'. The direction of the hierarchical layout. The available options are: UD, DU, LR, RL. To simplify: up-down, down-up, left-right, right-left.

zoomView

: Boolean. Default to true. When true, the user can zoom in.

Value

A diagram object representing the REDCap project structure.

Details

This function generates a visual diagram of the REDCap project structure, including forms, fields, and choices. It supports various options such as rendering the diagram, including fields and choices, and specifying the direction of the diagram.