# maryleneh/formation-dataviz architecture

> Architecture diagram of the GitHub repository maryleneh/formation-dataviz, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/maryleneh/formation-dataviz
- Repository: https://github.com/maryleneh/formation-dataviz

## Overview

##### Project’s Main Areas
- Training/Documentation Materials: Includes PowerPoint presentations, R Markdown files (diapo_cours_dataviz.Rmd), HTML outputs, and the README.
- Cheatsheets: A dedicated directory with various cheat sheets (for data visualization, R Markdown, shiny, etc.).
- Exercises: A collection of exercises in different formats (docx, pdf, HTML) along with supporting data files (e.g., rp2012.csv). Note that there is also a “complement” subfolder with additional cheat sheets.
- Assets and Supporting Files: Includes images, a CSS file (style.css) for styling documents, and additional supporting PPTX files.

##### And Organize the File Structure into Logical Components
- Course Content Module:
- Elements like “Eléments de Datavisualisation.pptx”, “Prise en main de ggplot2.pptx”, and “diapo_cours_dataviz.Rmd”/“diapo_cours_dataviz.html” should be grouped as core training slides/materials.
- Cheatsheet Module:
- The “cheatsheet” folder containing various PDF cheatsheets relates to quick reference material for learners.
- Exercise Module:
- The “exercices” folder contains interactive and practice content. Notice the further subdivision (e.g., “exercices/complement”) and associated files used to reinforce learning with hands-on examples.
- Visual/Styling Assets:
- The “images” folder and “style.css” support the visual components of the training materials.

##### Components
- Exercises Component: Represented as a separate module comprising different exercise files and documents. Include a sub-section or noted subdivision for “complement” if desired.

##### Depicting Relationships and Interactions
- Explicitly label dependencies, for example:
- “Data and Visual Assets” connecting to presentation and exercise documents.

##### Architectural Patterns and Design Principles
- Separation of concerns: By grouping content into separate modules (training, cheatsheets, exercises, assets), you clearly delineate each area’s responsibility.
- Modularity and Extensibility: Should there be additions (e.g., extra exercises or expanded cheat sheets), the modular design makes it clear where new files should be integrated.
- Transformation Pipelines: The conversion from R Markdown (source) to HTML (output) indicates a build step that could be visualized separately if needed.

- Layout: Start with a central “Training Content” block that connects to subsidiary blocks (Cheatsheets and Exercises). Then, attach an “Assets” block that feeds into the main content blocks, illustrating that the styling and images are shared resources.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Course Materials Subgraph
    subgraph "Course Materials"
        CM1["Eléments de Datavisualisation.pptx"]:::material
        CM2["Prise en main de ggplot2.pptx"]:::material
        CM3["diapo_cours_dataviz.Rmd"]:::material
        CM4["diapo_cours_dataviz.html"]:::material
        CM5["README.md"]:::material
        CM3 -->|"RMarkdownRendering"| CM4
    end

    %% Cheatsheets Subgraph
    subgraph "Cheatsheets"
        cs1["data-visualization-ggplot2.1.pdf"]:::cheatsheet
        cs2["rmarkdown-cheatsheet-2.0.pdf"]:::cheatsheet
        cs3["shiny-french-cheatsheet.pdf"]:::cheatsheet
    end

    %% Exercises Subgraph
    subgraph "Exercises"
        Ex1["Aide_Scales_et_Theme.docx"]:::exercise
        Ex2["Inspirathèque.pdf"]:::exercise
        Ex3["Les conseils pour des datavisualisations interactives réussies.pdf"]:::exercise
        Ex4["exercice_formation_dataviz.docx"]:::exercise
        Ex5["exercice_formation_dataviz.pdf"]:::exercise
        Ex6["fiche_corrplot.html"]:::exercise
        Ex7["fiche_corrplot_files"]:::exercise
        Ex8["fiche_plotly.html"]:::exercise
        Ex9["fiche_plotly_files"]:::exercise
        Ex10["rp2012.csv"]:::exercise
        subgraph "Complement"
            Ex11["base_r_cheatsheet.pdf"]:::exercise
        end
    end

    %% Assets Group (as a parent node with details)
    A["Assets"]:::assets
    AS1["images"]:::asset
    AS2["style.css"]:::asset
    A --> AS1
    A --> AS2

    %% Relationships and Data Flow
    %% Assets providing styling to Course Materials and Exercises (using representative nodes)
    A -->|"providesStyling"| CM1
    A -->|"providesStyling"| Ex1

    %% Course Materials feeding into Cheatsheets and Exercises
    CM1 -->|"feeds"| cs1
    CM1 -->|"feeds"| Ex1
    CM5 -->|"references"| cs1
    CM5 -->|"supports"| Ex1

    %% Click Events for Course Materials
    click CM1 "https://github.com/maryleneh/formation-dataviz/blob/master/Eléments de Datavisualisation.pptx"
    click CM2 "https://github.com/maryleneh/formation-dataviz/blob/master/Prise en main de ggplot2.pptx"
    click CM3 "https://github.com/maryleneh/formation-dataviz/blob/master/diapo_cours_dataviz.Rmd"
    click CM4 "https://github.com/maryleneh/formation-dataviz/blob/master/diapo_cours_dataviz.html"
    click CM5 "https://github.com/maryleneh/formation-dataviz/blob/master/README.md"

    %% Click Events for Cheatsheets
    click cs1 "https://github.com/maryleneh/formation-dataviz/blob/master/cheatsheet/data-visualization-ggplot2.1.pdf"
    click cs2 "https://github.com/maryleneh/formation-dataviz/blob/master/cheatsheet/rmarkdown-cheatsheet-2.0.pdf"
    click cs3 "https://github.com/maryleneh/formation-dataviz/blob/master/cheatsheet/shiny-french-cheatsheet.pdf"

    %% Click Events for Exercises
    click Ex1 "https://github.com/maryleneh/formation-dataviz/blob/master/exercices/Aide_Scales_et_Theme.docx"
    click Ex2 "https://github.com/maryleneh/formation-dataviz/blob/master/exercices/Inspirathèque.pdf"
    click Ex3 "https://github.com/maryleneh/formation-dataviz/blob/master/exercices/Les conseils pour des datavisualisations interactives réussies.pdf"
    click Ex4 "https://github.com/maryleneh/formation-dataviz/blob/master/exercices/exercice_formation_dataviz.docx"
    click Ex5 "https://github.com/maryleneh/formation-dataviz/blob/master/exercices/exercice_formation_dataviz.pdf"
    click Ex6 "https://github.com/maryleneh/formation-dataviz/blob/master/exercices/fiche_corrplot.html"
    click Ex7 "https://github.com/maryleneh/formation-dataviz/tree/master/exercices/fiche_corrplot_files"
    click Ex8 "https://github.com/maryleneh/formation-dataviz/blob/master/exercices/fiche_plotly.html"
    click Ex9 "https://github.com/maryleneh/formation-dataviz/tree/master/exercices/fiche_plotly_files"
    click Ex10 "https://github.com/maryleneh/formation-dataviz/blob/master/exercices/rp2012.csv"
    click Ex11 "https://github.com/maryleneh/formation-dataviz/blob/master/exercices/complement/base_r_cheatsheet.pdf"

    %% Click Event for Assets and its files
    click A "https://github.com/maryleneh/formation-dataviz/tree/master/assets"
    click AS1 "https://github.com/maryleneh/formation-dataviz/tree/master/images"
    click AS2 "https://github.com/maryleneh/formation-dataviz/blob/master/style.css"

    %% Styles
    classDef material fill:#D1E8FF,stroke:#1F77B4,stroke-width:2px;
    classDef cheatsheet fill:#FFF2CC,stroke:#D4AC0D,stroke-width:2px;
    classDef exercise fill:#D5F5E3,stroke:#27AE60,stroke-width:2px;
    classDef assets fill:#FADBD8,stroke:#C0392B,stroke-width:2px;
    classDef asset fill:#FAE5D3,stroke:#E67E22,stroke-width:2px;
```
