generateCsvReportReference.sh

#!/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

# Fail on any error ("-e" = exit on first error, "-o pipefail" exist on errors within piped commands)
set -o errexit -o pipefail

# Output Markdown file name
markdown_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"
}

echo "generateCsvReportReference: Generating ${markdown_file}..."

# Create the Markdown header
{
  echo "# CSV Cypher Query Result Reports Reference"
  echo ""
  echo "This document lists all CSV Cypher query result reports found in the current directory and its subdirectories."
  echo "Each entry in the table below includes the file name, the analysis type, the number of rows in the CSV, and the source Cypher query."
  echo "This file was automatically generated using the [generateCsvReportReference](./../documentation/analysis-reports-reference/generateCsvReportReference.sh) script."
  echo ""
  # Create the Markdown table header
  echo "| CSV File | Analysis | Number of Rows | Source Query |"
  echo "| -------- | -------- | -------------- | ------------ |"
} > "$markdown_file"

# Find and process CSV files
find . -type f -name "*.csv" | sort | 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 3)
  
  # 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) |" >> "$markdown_file"
done

echo "generateCsvReportReference: Successfully generated ${markdown_file}."