How maryleneh/formation-dataviz works
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.