Backward Traceability

by lingzhi2279e6c085d65e3No license386 starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated 7 months ago

Make every number in the final PDF traceable to the exact code line that produced it. Uses \hypertarget/\hyperlink LaTeX commands and \num{formula} evaluated at compile time. Use for reproducibility and data integrity verification.

AI-generated overview

Tags numeric results in code and links them to numbers in a LaTeX paper for traceability.

What it does
This skill makes numeric values in a compiled PDF traceable back to the code lines that produced them. It guides adding hypertarget tags to experiment output, referencing them with hyperlink commands in LaTeX, and using compile-time evaluated formulas for derived values. It also ships a Python script that scans a LaTeX file for hypertargets and hyperlinks, reports orphan or unreferenced values, and cross-checks paper values against code output.
When to use it
Use it when preparing a research paper whose numbers must be verifiable against the code that generated them. It fits reproducibility and data integrity checks, and verifying that every reported figure links to a specific code line.
Requirements
A LaTeX toolchain with the hyperref and listings packages, plus Python to run the bundled script scripts/ref_numeric_values.py. It operates on a paper project directory containing code and LaTeX files; no credentials or network access are described.

Backward Traceability

Make every number in the final PDF hyperlink back to the exact code line that produced it.

Input

  • $0 — Paper project directory containing code and LaTeX files

References

  • Traceability patterns and LaTeX commands: ~/.claude/skills/backward-traceability/references/traceability-patterns.md

Scripts

Scan hypertarget/hyperlink references

bash
python ~/.claude/skills/backward-traceability/scripts/ref_numeric_values.py \  --scan paper/main.tex --output report.json

Reports: all hypertargets, hyperlinks, orphan references, unreferenced numeric values.

Verify cross-reference integrity

bash
python ~/.claude/skills/backward-traceability/scripts/ref_numeric_values.py \  --verify paper/main.tex --code-output results.txt

Cross-checks values between paper text and code output. Reports mismatches.

Workflow

Step 1: Tag Code Outputs

For every numeric value produced by experiment code, add hypertarget tags:

python
# In experiment code output:print(f"\\hypertarget{{R1a}}{{45.3}}")  # Mean accuracyprint(f"\\hypertarget{{R1b}}{{2.1}}")   # Std deviation

Label format: {prefix}{line_number}{letter} where letter = a, b, c... for multiple values on same line.

Step 2: Reference in Paper Text

Use \hyperlink to create clickable references in the paper:

latex
Our method achieves \hyperlink{R1a}{45.3}\% accuracy($\pm$\hyperlink{R1b}{2.1}).

Step 3: Use \num for Computed Values

For values derived from other values, use \num{} for compile-time evaluation:

latex
% \num{formula, "explanation"} → evaluated at compile timeThe improvement is \num{45.3 - 38.7, "accuracy gain"}\%.

Step 4: Generate Appendix Code Listing

Create an appendix with the full code listing, with \hypertarget anchors at relevant lines:

latex
\section*{Appendix: Code Listing}\begin{lstlisting}[escapechar=@]@\hypertarget{code1}{}@result = model.evaluate(test_data)@\hypertarget{code2}{}@accuracy = result['accuracy']\end{lstlisting}

Step 5: Verify Traceability

  • Every number in the paper text must have a corresponding \hypertarget in the code
  • Every \num{} formula must evaluate correctly
  • Click-test: every hyperlink in the PDF must jump to the correct code line

LaTeX Setup

Required packages:

latex
\usepackage{hyperref}\usepackage{listings}

Rules

  • Every numeric result in the paper MUST trace to code output
  • Never manually type numbers — always reference tagged outputs
  • Use \num{} for any derived/computed values
  • Code listing in appendix must match actual executed code
  • Verify all hyperlinks resolve correctly after compilation

Related Skills

  • Upstream: experiment-code, data-analysis
  • Downstream: paper-compilation
  • See also: paper-assembly

Source and attribution

Source:lingzhi227/agent-research-skillsinskills/backward-traceabilityat commit9e6c085

License: No license

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal