How to cite

CardiacNexus documentation should make it clear which sources support each feature definition, method, and reference range.

Modality
All modalities
Pipeline step
Documentation provenance
Outputs
Citation and provenance guidance
Maturity
Draft interpretation page

Citation model

Use inline numeric citations that link to page-level references, for example CMR reference values are cohort- and method-dependent [1].

Page-level references

Phenotype and method pages should keep references close to the claims they support. The preferred pattern is an inline numeric citation in the paragraph and a page-level References section using the shared reference anchor component. This keeps citations readable in the clinical text while still allowing one-click navigation to source details.

What should be cited

  • UK Biobank CMR protocol statements
  • CMR normal ranges and reference intervals
  • Feature definitions that follow published conventions
  • Disease association claims
  • Method-specific details for strain, flow, T1, ECV, or registration
  • Implementation provenance when a claim depends on current CardiacNexus source code or output schema

Citation scope

Do not rely on one global bibliography alone. A reader should be able to tell which source supports the feature or caveat on the page they are reading.

Source audit

  • docs/data/reference_sources.yml exists and is the active bibliography/source registry for page-level references.
  • docs/data/reference_range_sources.yml is the active row-level registry for reference-range values and method context.
  • Code paths, output inventories, and QA reports should stay in Source audit or Implementation provenance sections instead of being mixed into scientific References.
  • Textbook context boundary: broad clinical textbook context is not surfaced here because this page documents citation mechanics rather than clinical background.

References

  1. Use the final CardiacNexus manuscript, software DOI, or repository citation here when available.