getReportReference: getReportReference

Description Usage Arguments Value Author(s) See Also Examples

View source: R/Report-methods.R

Description

Creates a string that points to the given reference item in the specified report.

Usage

1
getReportReference(report, txt)

Arguments

report

Report that contains the reference to be cited.

txt

Text of the reference in the form of a non-empty character vector. This reference must already added to the report.

Value

Citation of the reference item (including a link) in the form of a one-element character vector. If the specified reference item is not found in the report, this method returns an empty string.

Author(s)

adapted by Fabian Mueller from RnBeads code by Yassen Assenov

See Also

addReportReference for adding a reference item to a report; Report for other functions adding contents to an HTML report

Examples

1
2
3
4
5
report <- createReport("example.html", "Example", init.configuration = TRUE)
txt.reference <- c("Bird A. ", "<i>Nucleic Acids Res.</i> <b>8</b> (1980)")
report <- addReportReference(report, txt.reference)
txt <- c("This was shown in ", getReportReference(report, txt.reference), ".")
addReportParagraph(report, txt)

demuellae/muReportR documentation built on Jan. 20, 2020, 5:12 a.m.