Content
53%Weight 40%Scale 1-5Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
The body is well-sectioned and highly actionable, with real code, column names, and endpoints for all eight databases. Its core structural flaw is that it is a monolithic ~560-line inline implementation while three equivalent scripts sit unreferenced in scripts/, duplicating functionality and wasting the context window; workflows also lack validation checkpoints.
Suggestions
Replace the inline COSMIC, BioGRID/PPI, and MSigDB code sections with brief overviews plus explicit references to the existing bundle scripts (e.g. 'Run: python scripts/build_ppi_network.py --biogrid-file ... --gene-list ...'), making the provided scripts discoverable.
De-duplicate 'parse_gmt' (defined in both Quick Start and section 6 with different return formats) and trim print-boilerplate from the remaining functions.
Turn the 'Typical Workflows' into sequenced steps with validation checkpoints (e.g. download → verify file/row count → load → filter → report) so failures are caught early.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | Prose is lean and code-dense rather than padded, but the ~560-line body could be tightened: 'parse_gmt' is defined twice (Quick Start and section 6) with divergent return shapes, and every function carries verbose print-based reporting boilerplate. Matches 'mostly efficient but could be tightened' rather than the minor-trim level of 4. | 3 / 5 |
Actionability | Each section ships concrete, executable pandas/networkx/requests code with real column names ('Tumour Types(Somatic)', 'MAPPED_GENE'), download URLs, and file names — close to copy-paste ready. It stays at 4 rather than 5 because acquiring the data is only described in comments (e.g. 'requires free registration') with no runnable download step, and code assumes the local files already exist. | 4 / 5 |
Workflow Clarity | The three 'Typical Workflows' are 2–3-line snippets, not sequenced processes; there are no validation checkpoints (e.g. verify a download parsed to expected row counts) or explicit feedback loops. The Troubleshooting section provides some problem/solution recovery, which keeps this at 3 ('sequence present but checkpoints missing') rather than 2. | 3 / 5 |
Progressive Disclosure | The bundle provides three substantive scripts (scripts/build_ppi_network.py, scripts/download_cosmic.py, scripts/parse_msigdb.py) that duplicate the PPI, COSMIC, and MSigDB sections, yet the body never references any of them and instead inlines ~500 lines of code that clearly belongs in those files. Per the rubric guideline on scoring against the actual bundle structure, the provided files are orphaned and undiscoverable — 'content that clearly belongs in separate files is inlined' at anchor 2, not 3, since no references to the bundle exist at all. | 2 / 5 |
Total | 12 / 20 Passed |