Add script to generate CSV report reference doc

Author: JohT

COMMANDS.md

@@ -118,6 +118,17 @@ Change into the [scripts](./scripts/) directory e.g. with `cd scripts` and then
 ./documentation/generateScriptReference.sh
 ```
 
+### Generate CSV Cypher Query Report Reference
+
+Change into the [results](./results/) directory e.g. with `cd results` and then execute the script [generateCsvReportReference.sh](./scripts/documentation/generateCsvReportReference.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/generateCsvReportReference.sh
+```
+
 ### Generate Jupyter Notebook Report Reference
 
 Change into the [results](./results/) directory e.g. with `cd results` and then execute the script [generateJupyterReportsReference.sh](./scripts/documentation/generateJupyterReportsReference.sh) with the following command:

README.md

@@ -81,6 +81,10 @@ The [Code Structure Analysis Pipeline](./.github/workflows/code-structure-analys
 
 [COMMANDS.md](./COMMANDS.md) contains further details on commands and how to do a manual setup.
 
+## 📃 CSV Cypher Query Report Reference
+
+[CSV_REPORTS.md](./results/CSV_REPORTS.md) lists all CSV Cypher query result reports inside the [results](./results) directory. It can be generated as described in [Generate Jupyter Notebook Report Reference](./COMMANDS.md#generate-csv-cypher-query-report-reference).
+
 ## 📈 Jupyter Notebook Report Reference
 
 [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).

scripts/copyReportsIntoResults.sh

@@ -40,5 +40,8 @@ for report_source_folder in **/"${REPORTS_DIRECTORY}"; do
     cp -Rp "${report_source_folder}" "${reportTargetDirectory}"
 done
 
-# Generate REPORTS.md containing a reference to all Jupyter Notebook Markdown reports in the "results" directory and its subdirectories.
-(cd "./../${RESULTS_DIRECTORY}" && exec "${SCRIPTS_DIR}/documentation/generateJupyterReportsReference.sh")
+# Generate JUPYTER_REPORTS.md containing a reference to all Jupyter Notebook Markdown reports in the "results" directory and its subdirectories.
+(cd "./../${RESULTS_DIRECTORY}" && exec "${SCRIPTS_DIR}/documentation/generateJupyterReportsReference.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")

scripts/documentation/generateCsvReportReference.sh

@@ -0,0 +1,56 @@
+#!/usr/bin/env bash
+
+# Generates "CSV_REPORTS.md" containing a reference to all CSV cypher query reports in this directory and its subdirectories.
+
+# Note: This script was generated by Chat-GPT after some messages back and forth:
+# https://chat.openai.com/share/0bd3cde7-32d0-460d-830c-79b7d00a2492
+
+# Output Markdown file name
+output_file="CSV_REPORTS.md"
+
+# Function to count rows in a CSV file
+count_rows() {
+  wc -l < "$1"
+}
+
+# Function to extract the source query name from CSV header
+get_source_query() {
+  header=$(head -n 1 "$1")
+  source_query=$(echo "$header" | sed -n 's/.*Source Cypher File: \(.*\)"/\1/p')
+  echo "$source_query"
+}
+
+# Create the Markdown header
+{
+  echo "# CSV Cypher Query Reports Reference"
+  echo ""
+  echo "This document serves as a reference for all CSV Cypher query reports in the current directory and its subdirectories. It provides a table listing each file, its corresponding analysis, the row count and the source query. This file was generated with the script [generateCsvReportsReference](./../scripts/documentation/generateCsvReportsReference.sh)."
+  echo ""
+  
+  # Create the Markdown table header
+  echo "| CSV File | Analysis | Number of Rows | Source Query |"
+  echo "| -------- | -------- | -------------- | ------------ |"
+} > "$output_file"
+
+# Find and process CSV files
+find . -type f -name "*.csv" | while IFS= read -r csv_file; do
+  num_rows=$(count_rows "$csv_file")
+  source_query=$(get_source_query "$csv_file")
+  
+  # Get the main directory name
+  main_dir=$(dirname "$csv_file" | cut -d '/' -f 2)
+  
+  # Get the base name of the file
+  base_name=$(basename "$csv_file")
+  
+  # Escape special characters for Markdown
+  csv_link=$(echo "$csv_file" | sed 's/\[/\\[/g; s/\]/\\]/g')
+  
+  # Create a link to the source query
+  source_query_link="./../cypher/$source_query"
+  
+  # Append a new row to the Markdown table
+  echo "| [$base_name]($csv_link) | $main_dir | $num_rows | [$source_query]($source_query_link) |" >> "$output_file"
+done
+
+echo "CSV table and header generated in $output_file"