Datamonger for Python · python · 0.1.0

datamonger.cite_data

cite_data(name: str, *, source: str | None = None, version: str | None = None, registry: Registry | None = None, cache_dir: Pathish | None = None, offline: bool = False, include_all: bool = False, format: typing.Literal["text"] = "text") -> str

cite_data(name: str, *, source: str | None = None, version: str | None = None, registry: Registry | None = None, cache_dir: Pathish | None = None, offline: bool = False, include_all: bool = False, format: typing.Literal["records"]) -> tuple[collections.abc.Mapping[str, typing.Any], ...]

Return curated citations without retrieving dataset artifacts.

Select references explicitly marked as recommended by upstream. If no recommendation flags are recorded, return all references and state that the recommendation is unknown in text output. include_all=True returns every reference. format="records" preserves roles, notes, and optional recommendation flags. Full metadata and upstream instructions are also available through data_info() and fetch results with return_info=True.

Registry selection, dataset references, and offline behavior match data_info(). Formatting uses only curated text; it performs no DOI lookup.