rnb.get.reference: rnb.get.reference

Description Usage Arguments Value Author(s) See Also Examples

Description

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

Usage

1
rnb.get.reference(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)

Yassen Assenov

See Also

rnb.add.reference 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 <- rnb.add.reference(report, txt.reference)
txt <- c("This was shown in ", rnb.get.reference(report, txt.reference), ".")
rnb.add.paragraph(report, txt)


Search within the RnBeads package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.