Generate image reference for results

Author: JohT

COMMANDS.md

@@ -140,6 +140,17 @@ which is included in the pipeline [code-structure-analysis.yml](.github/workflow
 ./../scripts/documentation/generateJupyterReportReference.sh
 ```
 
+### Generate Image Reference
+
+Change into the [results](./results/) directory e.g. with `cd results` and then execute the script [generateImageReference.sh](./scripts/documentation/generateImageReference.sh) with the following command:
+
+👉**Note:** This script is automatically triggered at the end of [copyReportsIntoResults.sh](./scripts/copyReportsIntoResults.sh)
+which is included in the pipeline [code-structure-analysis.yml](.github/workflows/code-structure-analysis.yml) and doesn't need to be executed manually normally.
+
+```script
+./../scripts/documentation/generateImageReference.sh
+```
+
 ### Generate Environment Variable Reference
 
 Change into the [scripts](./scripts/) directory e.g. with `cd scripts` and then execute the script [generateEnvironmentVariableReference.sh](./scripts/documentation/generateEnvironmentVariableReference.sh) with the following command:

README.md

@@ -85,6 +85,10 @@ The [Code Structure Analysis Pipeline](./.github/workflows/code-structure-analys
 
 [JUPYTER_REPORTS.md](./results/JUPYTER_REPORTS.md) lists all Jupyter Notebook reports inside the [results](./results) directory. It can be generated as described in [Generate Jupyter Notebook Report Reference](./COMMANDS.md#generate-jupyter-notebook-report-reference).
 
+## 📈 Image Reference
+
+[IMAGES.md](./results/IMAGES.md) lists all PNG images inside the [results](./results) directory. It can be generated as described in [Generate Image Reference](./COMMANDS.md#generate-image-reference).
+
 ## ⚙️ Script Reference
 
 [SCRIPTS.md](./scripts/SCRIPTS.md) lists all shell scripts of this repository including their first comment line as a description. It can be generated as described in [Generate Script Reference](./COMMANDS.md#generate-script-reference).

scripts/copyReportsIntoResults.sh

@@ -44,4 +44,7 @@ done
 (cd "./../${RESULTS_DIRECTORY}" && exec "${SCRIPTS_DIR}/documentation/generateJupyterReportReference.sh")
 
 # Generate CSV_REPORTS.md containing a reference to all CSV cypher query reports in the "results" directory and its subdirectories.
-(cd "./../${RESULTS_DIRECTORY}" && exec "${SCRIPTS_DIR}/documentation/generateCsvReportReference.sh")
+(cd "./../${RESULTS_DIRECTORY}" && exec "${SCRIPTS_DIR}/documentation/generateCsvReportReference.sh")
+
+# Generate IMAGES.md containing a reference to all PNG images in the "results" directory and its subdirectories.
+(cd "./../${RESULTS_DIRECTORY}" && exec "${SCRIPTS_DIR}/documentation/generateImageReference.sh")

scripts/documentation/generateImageReference.sh

@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+
+# Generates "IMAGES.md" containing a reference to all images (PNG) in this directory and its subdirectories.
+
+# Markdown file name
+markdown_file="IMAGES.md"
+
+{ 
+  echo "# Image Reference" 
+  echo ""
+  echo "This document serves as a reference for all images (PNG) in the current directory and its subdirectories."
+  echo "It provides a table listing each file and the analysis it belongs to."
+  echo "This file was generated with the script [generateImageReference.sh](./../scripts/documentation/generateImageReference.sh)."
+  echo ""
+  echo "Image  | Analysis |"
+  echo "-------|----------|" 
+} > ${markdown_file}
+
+# Loop through all Markdown files in the current directory
+find . -type f -name "*.png" | sort | while read -r image_file; do
+    # Trim leading and trailing whitespace
+    description=$(echo "${description}" | awk '{$1=$1;print}')
+
+    # Extract the script file name without the path
+    filename=$(basename "$image_file")
+    
+    if [ "$filename" = "${markdown_file}" ]; then
+      continue
+    fi
+    
+    # Extract the script file path without the name
+    pathname=$(dirname "$image_file")
+    
+    # Extract the second part of the path after ./ that contains the analysis directory name
+    analysisname=$(echo "${pathname}" | cut -d/ -f2)
+
+    # Create a link to the script file in the table
+    link="[${filename}](${image_file})"
+    
+    # Add the script file and its description to the Markdown table
+    echo "| ${link} | ${analysisname%%.} |" >> ${markdown_file}
+done