sddb.citations.citation_entries

sddb.citations.citation_entries(results: SpatialDataCohort, *, bib_url: str | None = None) → tuple[str, int, int]

Return (BibTeX text, n_published, n_fallback) that cite every study in results.

bib_url defaults to citations.bib next to the catalog. A study whose study_id is a key in that file gets its published entry. Every other study, and every dataset without a study_id, gets a @misc fallback entry keyed by the study_id (or the uid). It cites the dataset page on the website and carries the title, DOI, year, uid and license from the catalog. The datasets of one study share one entry.

The published file has one entry per study, and a GEO study is one sample, so a paper with many samples appears many times. Published entries that share a DOI are merged into one: the first (by key) keeps its key and fields, and its note gains "covers samples: <key>, ..." with every key it stands for (the first five, then a count). Fallback entries that share a DOI merge the same way. n_published and n_fallback count the entries after merging.

One warning reports the counts when there are fallback entries, because those entries should be checked before you publish. An empty cohort raises ValueError.