Introduction

[This is a heading using markdown syntax]

Markdown files contain a combination of code and text, allowing you to write your analysis alongside your code and publish both the text and the outputs generated by R code ((tables, graphs, etc.) in a single document in formats of your choice (HTML, PDF, DOCX) quickly and minimal effort.

The rest of the document shows example snippets (showing text and outputs weaved together including the R code chunks to demonstrate the concepts with annotations. Annotations are added to help you to understand how it is done.

Diagrammes using GraphViz

[This is a heading using Markdown syntax]

This is a separate document.

State Machine Rules Example

[This is sub-heading using Markdown syntax]

[The graphic below is automatically generated from embedded R code chunk]

[The actual code is contained within “chunks” which look like this:]

DiagrammeR::grViz("_dot/hzrd.dot")

Organisation Charts Example

[Another sub-heading using Markdown syntax]

[The graphic below is automatically generated from embedded R code chunk]

DiagrammeR::grViz("_dot/orgchart.dot")

Data Model Example

[Another sub-heading using Markdown syntax] [The graphic below is automatically generated and saved from R code chunk and shown as an svg image using Markdown syntax.]

library(DiagrammeR)
library(DiagrammeRsvg)
library(magrittr)
library(rsvg)

 #svg <- export_svg(grViz("_dot/datamodel.dot"))

g <- export_svg(grViz("_dot/datamodel.dot"))

g %>% charToRaw %>% rsvg_svg("_images/graph.svg")

g %>% charToRaw %>% rsvg_png("_images/graph.png")

Data Model

Diagrammes using mermaid

[This is a heading using Markdown syntax]

This is a separate document.

Gantt Charts

[This is a sub-heading using Markdown syntax]

Example: Timeline gantt chart for consultancy services under E365 [Graphic generated from embedded R code]

m <- DiagrammeR::mermaid("_mmds/gantt.mmd")
m$x$config = list(ganttConfig = list(
  axisFormatter = list(list(
    "%b %d, %Y" 
    ,htmlwidgets::JS(
      'function(d){ return d.getDay() == 1 }' 
    )
  ))
))
m

Sequence Diagrammes

[Sub-heading using Markdown syntax]

[*Example: Sequence diagrammes to describe the various workflows [Graphic generated from embedded R code]

DiagrammeR::mermaid("_mmds/sequenceDiagrammes.mmd")

Another document

[This is a heading using Markdown syntax.]

This is a separate document.

Attributes Example

[This is a sub-heading using Markdown syntax]

Example of a table created in Excel and converted to Markdown syntax using an online free markdown editor.

[This is table generated using Markdown syntax]

Attribute Comments from Bentley
Specification ID Can prefix be provided for this? Please note that this is auto generated attribute.
Clause No Should this be shown in a separate column or shown within the requirement itself?
Description as-is
Statement Type Current values are as per RMP - Table 4. Any change?
Tracked Requirement Current values are as per RMP - Table 4. Any change?
Requirement Identification Status Requirement Identification ReviewWorkflow: Current values: Ready for Internal Review; Ready for Review; Reviewed by Engineer; Revise; Any change?
Allocated Disciplines The values are Etihad Rail specific and need changing. Can RTS specific list of disciplines be provided?
Allocated System/Sub System Can Ignore at present
Allocated Location. Can Ignore at present
Allocated Design Verification Stage(s) This will be changed to: PDR; Pre-FDR; FDR. Confirm ok?
Verification Allocation Status Requirement Verification Allocation Review Workflow: Current values: Ready for Internal Review; Ready for Review; Reviewed by Engineer; Revise; Any change?
Verification Acceptance Criteria as-is
Verification Acceptance Criteria Status Requirement Verification Acceptance Criteria Review Workflow: Current values: Ready for Internal Review; Ready for Review; Reviewed by Engineer; Revise; Any change?
Verification Status for PDR Current values: Ready for Internal Review; Ready for Review; Reviewed by Engineer; Revise; Any change?
Verification Status for Pre-FDR Current values: Ready for Internal Review; Ready for Review; Reviewed by Engineer; Revise; Any change?
Verification Status for FDR Current values: Ready for Internal Review; Ready for Review; Reviewed by Engineer; Revise; Any change?
Requirement Status @ Verification Stage Shows various states of RM workflow: Current values: Identified; Allocated; Verification Criteria agreed; Verification evidence linked - PDR; Verification evidence accepted-PDR; Verification evidence linked - Pre-FDR; Verification evidence accepted-Pre-FDR; Verification evidence linked - FDR; Verification evidence accepted-FDR;
Allocated Validation Stage(s) Can Ignore at present
Allocated Validation Stage(s) [New] Can Ignore at present
Validation Method Can Ignore at present
Validation Method [New] Can Ignore at present
Validation Allocation Status Can Ignore at present
Validation Acceptance Criteria Can Ignore at present
Validation Acceptance Criteria Status Can Ignore at present
Validation Stage Can Ignore at present
Requirement Status @ Validation Stage Can Ignore at present
Contractor Response as-is
Engineer Comment as-is
ER/PMC Comment as-is
Change History as-is
Remarks as-is

Database Folder Structure

[This is a sub-heading using Markdown syntax]

[This is a list using Markdown syntax]

  • ROOT
    • ▶ Config
      • ▶ Default
        • ▶ C01 Global
        • ▶ C02 Config
        • ▶ C03 DMS Sync
        • ▶ C04 Graphics
        • ▶ PC01 Requirements
        • ▶ PC02 Breakdown Structures
        • ▶ PC03 Hazards
        • ▶ PC04 Changes
        • ▶ PC05 Assumptions
        • ▶ PC07 Derogations
        • ▶ PC08 Interfaces

Send Document by email Example

[With the embedded R code you can generate an Outlook email and distribute the compiled document as an attachment quickly speeding up the distribution process.]