Datamonger

Datamonger for R · r · 0.0.0.9000

Get Curated Dataset Citations

cite_data

Source: packages/r/R/citations.R, packages/r/man/cite-data.Rd

Retrieve curated citations from the selected registry without downloading artifacts or looking up bibliographic identifiers. Multiple references can be recommended together. Optional roles describe a dataset, paper, or collection; roles do not imply recommendations.

Usage

cite_data(name, source = NULL, version = NULL, registry = NULL,
  cache_dir = NULL, offline = FALSE, include_all = FALSE, format = "text")

Arguments

  • name

    A bare dataset name, source:name, or source:name@version.

  • source

    Dataset source. Required for bare names; omit for qualified references.

  • version

    Exact dataset version. Omit when embedded in name. An omitted version selects the registry default.

  • registry

    A strong selector, or NULL for the active selector.

  • cache_dir

    An explicit cache directory, or NULL for the platform default.

  • offline

    Whether to use only bundled or verified cached registry bytes.

  • include_all

    Whether to include every reference regardless of recommendation.

  • format

    Either "text" or "records".

Details

By default, return references explicitly marked as recommended by upstream. If no reference carries a recommendation flag, return all references and explain the unknown recommendation in text output. If flags exist but none is true, return an empty selection. Missing citation metadata produces an explicit text message or an empty list. The legacy single citation remains supported.

All references and upstream instructions are also available as citations and citation_instructions in data_info() and fetch metadata from fetch_data(return_info = TRUE). An absent recommendation flag means unknown, whereas FALSE records that the reference is not recommended.

Value

A character string with role labels, notes, and upstream instructions, or a list of citation records with optional role, note, and recommended fields preserved.

See also

data_info, fetch_data