set_citation: Set the citation of a design

Description Usage Arguments Value Examples

View source: R/set_citation.R

Description

Set the citation of a design

Usage

1
2
3
4
5
6
7
8
set_citation(
  design,
  title = NULL,
  author = NULL,
  year = NULL,
  description = "Unpublished research design declaration",
  citation = NULL
)

Arguments

design

A design typically created using the + operator

title

The title of the design, as a character string.

author

The author(s) of the design, as a character string.

year

The year of the design, as a character string.

description

A description of the design in words, as a character string.

citation

(optional) The preferred citation for the design, as a character string, in which case title, author, year, and description may be left unspecified.

Value

a design object with a citation attribute

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
design <-
declare_model(data = sleep) +
  declare_sampling(S = complete_rs(N, n = 10), legacy = FALSE)

design <-
  set_citation(design,
               author = "Lovelace, Ada",
               title = "Notes",
               year = 1953,
               description = "This is a text description of a design")

cite_design(design)

DeclareDesign documentation built on Feb. 15, 2021, 1:07 a.m.