cite_options: Toggles for various citation options

Description Usage Arguments Value

View source: R/cite_options.R

Description

Toggles for various citation options

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
cite_options(
  citation_format = "compatibility",
  style = "text",
  hyperlink = FALSE,
  cite.style = "authoryear",
  super = FALSE,
  max.names = 4,
  longnamesfirst = FALSE,
  check.entries = FALSE,
  ...
)

Arguments

citation_format

'pandoc', 'compatibility' (with version 0.5 or earlier), or 'text'

style

plain "text" style (default) inline citations, "markdown" style or or html style links to the hyperlink

hyperlink

Either logical (FALSE), or link "to.doc" (by DOI if available, otherwise to URL), or link "to.bib" section.

cite.style

Should inline textual citations use "authoryear", "numeric", or "authortitle" format?

super

logical, should numeric cite.style be a superscript?

max.names

numeric, maximum number of names to list before adding "et al.".

longnamesfirst

logical. Should all authors be listed the first time a citation is used (rather than obeying max.names?)

check.entries

logical. Should error if any 'required' bibtex field is missing? Default FALSE

...

additional arguments to BibOptions

Value

updates the option specified for the duration of the session.


cboettig/knitcitations documentation built on Jan. 12, 2021, 10:24 a.m.