review-citations

Audit citations.yml against workflow @citation keys and report inconsistencies.

521|81|Updated Feb 22, 2019
One-click install
npx skills add https://github.com/bactopia/bactopia --skill review-citations
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-citations
Source: https://github.com/bactopia/bactopia/tree/main/.claude/skills/review-citations
Command: npx skills add https://github.com/bactopia/bactopia --skill review-citations

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires conda, python3, bactopia-citations, and includes scripts (resource) components.

What problem does it solve?

This skill validates and audits citation usage across Bactopia's citations.yml and workflow @citation tags, identifying orphan keys and workflow references that do not resolve, and helping maintain provenance-consistent metadata.

Core Features & Use Cases

  • Detect orphan citation keys defined in data/citations.yml but never referenced by any @citation tag.
  • Flag workflow @citation keys that do not map to an entry in citations.yml.
  • Surface provenance-only entries (provenance_only) for informational purposes and future wiring.
  • Guide you through recommended fixes and how to apply wire-ups or clean removals.

Quick Start

Run bactopia-citations --validate to generate the integrity report.

Frequently Asked Questions about review-citations

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit citation keys in a reproducible workflow?

You can audit citation keys by running bactopia-citations --validate to generate an integrity report. This report compares your data/citations.yml file against workflow @citation tags to identify orphan keys, missing references, and provenance-only entries.

What causes orphan citation keys in a citations.yml file?

Orphan citation keys in a citations.yml file occur when metadata entries are defined but never referenced by any workflow @citation tag. Auditing tools detect these unreferenced entries to help maintain provenance-consistent metadata and guide clean removals.

How do I find missing workflow citation references in a complex repository?

Finding missing workflow citation references requires a validation tool that flags @citation keys not mapped to an entry in citations.yml. The bactopia-citations wrapper produces a JSON report detailing these missing keys to surface unresolved references in complex citation graphs.

Does the bactopia-citations validation wrapper require Python and conda?

Yes, the bactopia-citations validation wrapper requires conda, python3, and the bactopia-citations package to operate. These dependencies are necessary to parse complex citation graphs and emit the automated JSON payload for integrity auditing.

Can I surface provenance-only entries in a workflow citation audit?

Yes, a citation audit can surface provenance_only entries for informational purposes and future wiring. The validation process identifies these entries to help you track metadata that exists for provenance but lacks active workflow references.

What is the best way to fix unresolved workflow @citation tags?

Fixing unresolved workflow @citation tags involves applying recommended wire-ups or clean removals based on the audit report. The validation output guides you through resolving orphan keys and missing references to maintain provenance-consistent metadata.