Declare Research Study Citation

declare_citation(..., handler = citation_handler, label = NULL)

citation_handler(data = stop("Don't evaluate data argument"), title = NULL,
  authors = NULL, description = "Unpublished research design declaration.",
  timestamp = Sys.time(), citation = NULL)

Arguments

...

Arguments to the citation function

handler

A function that takes a data.frame and yield citation data

label

a step label

data

a data.frame

title

(optional) The title of the study, as a character string.

authors

(optional) The authors of the study, as a character string.

description

(optional) A description of the design in words, as a character string, stored alongside the declaration in code.

timestamp

a timestamp to use in the citation

citation

(optional) The preferred citation for the design, as a character string. Either include the full citation in text, or paste a BibTeX entry. If title and authors are specified and you leave citation empty, a BibTeX entry will be created automatically.

Value

a function that takes a data.frame as an argument and returns citation data