make.r.doc.references: Generate an R-Documentation Style References Section

In thomasWeise/literatureAndResultsGen: A code/data generator package that can be used to build and validate code and data for R packages for presenting literature and results

Description

Generate an R-Documentation style references section that can readily be inserted as an R documentation comment.

Usage

make.r.doc.references(refs, bibliography, logger = NULL,
  subst.doi = "doi:\\\\href\\{\\2\\}\\{\\1\\}",
  subst.url = "\\\\url\\{\\1\\}",
  first.line.start = "#' @references ", first.line.end = "",
  first.line.as.separate.line = FALSE, make.text.before = NULL,
  make.text.after = NULL, normal.line.start = "#' ",
  normal.line.end = "", between.two.lines = "#'",
  after.first.line = "#'", sort = TRUE)

Arguments

refs	an arbitrary collection of vectors with reference IDs
bibliography	a bibliography data set
logger	an optional logger function
subst.doi	a substitute regular expression for dois: "\1" is the doi, "\2" is the full link (optional, default value is supplied)
subst.url	a substitute regular expression for urls, "\1" is the url (optional, default value is supplied)
first.line.start	the starting string of the first line (optional, default value is supplied)
first.line.end	the ending string of the first line (optional, default value is supplied)
first.line.as.separate.line	should first.line.start be a separate line (TRUE) or should it be the beginning pasted in front of a normal line of references (FALSE) (optional, default value is supplied)
make.text.before	a function to which the reference id is passed and which should return a string to be pasted before the actual reference text (or ""); NULL is supplied by default, meaning that no strings are added
make.text.after	a function to which the reference id is passed and which should return a string to be pasted after the actual reference text, (or ""); NULL is supplied by default, meaning that
normal.line.start	a string to paste at the beginning of every normal line (optional, default value is supplied)
normal.line.end	a string to paste at the end of every normal line (optional, default value is supplied)
between.two.lines	a string to be pasted as separate line between two normal lines (optional, default value is supplied)
after.first.line	the string to be inserted as line after the first line (optional, default value is supplied)
sort	should the bibliographic references be sorted?

Value

the multi-line reference text

thomasWeise/literatureAndResultsGen documentation built on Nov. 5, 2019, 10:07 a.m.