Description Usage Arguments Value
View source: R/make_r_doc_references.R
Generate an R-Documentation style references section that can readily be inserted as an R documentation comment.
1 2 3 4 5 6 7 8 | 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)
|
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 |
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 |
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 |
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? |
the multi-line reference text
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.