Repository files navigation

R package pedMermaid generatesMermaid syntax for creating a pedigree flowchart inMarkdown andR Markdown, from a pedigree data frame.

Install the latest official version from CRAN:

install.packages("pedMermaid")

Install the latest development version (if different from the official version) from GitHub:

devtools::install_github('nilforooshan/pedMermaid')

This is a basic example of a pedigree flowchart created by the Mermaid syntax generated by the R package pedMermaid.

library(pedMermaid)ped<-data.frame(ID=1:7,SIRE= c(0,0,1,0,3,0,5),DAM= c(0,0,2,2,4,0,6))x<- mermaid_md(ped)# cat(x, sep = "\n") # Display the output syntax on-screen

flowchart TB    1 & 2 --> 3    2 --> 4    3 & 4 --> 5    5 & 6 --> 7

R package pedMermaid is equipped with functionsmermaid_md andmermaid_rmd for generating Mermaid flowchart syntax for Markdown and R Markdown, respectively.The syntax generated bymermaid_rmd is also applicable to Markdown.However, the syntax is more restricted (less customizations) and less compact.Themermaid_md function provides the following customizations:

• Links
  • Orientation (top-to-bottom or left-to-right)
  • Type (arrow or line)
  • Curve (not supported bymermaid_rmd)
  • Dash (dashed or solid) (not supported bymermaid_rmd)
  • Line width (not supported bymermaid_rmd)
  • Color (not supported bymermaid_rmd)
• Nodes (node-specific)
  • Text color (not supported bymermaid_rmd)
  • Background color
  • Border color
  • Round border
  • Dashed (or solid) border
  • Line width of the border