File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 11#!/usr/bin/env python3
22"""
3- Simple script to update README.md with current dataset statistics using only pandas .
3+ ⚠️ DEPRECATED: This script generates the old verbose README format .
44
5- ⚠️ NOTE: This script generates the OLD README format with extensive details.
6- The current README is simplified and focuses on essentials only.
5+ The current README has been simplified (README.md) and focuses on essentials only.
76Detailed documentation is now in the docs/ directory.
87
9- If you need to update statistics in the README, manually update the numbers in:
10- - README.md (main statistics)
11- - docs/training.md (baseline results)
12- - docs/visualization.md (if needed)
8+ This script is kept for reference but should not be used to regenerate the README.
9+ To update dataset statistics, manually edit:
10+ - README.md (lines 8-13: main statistics in Dataset Overview section)
11+ - README.md (lines 113-117: top 5 species in Dataset Details section)
12+ - README.md (lines 122-126: top 5 sites in Geographic Distribution section)
1313
14- Usage:
14+ For maintaining consistency, consider creating a simple stats updater that only
15+ updates specific statistics in the simplified README rather than regenerating
16+ the entire file.
17+
18+ Original usage:
1519 python scripts/update_readme.py --csv /path/to/data.csv --readme /path/to/README.md
1620"""
1721
You can’t perform that action at this time.
0 commit comments