getReportDir: getReportDir

Description Usage Arguments Value Author(s) See Also Examples

View source: R/Report-methods.R

Description

Gets the location of the given report-specific directory.

Usage

1
2
getReportDir(report, dir = c("data", "images", "images_highres", "pdfs"),
  absolute = FALSE)

Arguments

report

Report of interest.

dir

Type of directory to get. Must be one of "data", "images", "images_highres" or "pdfs".

absolute

Flag indicating if the absolute path of the directory is to be returned. If this is FALSE, the directory name is returned relative to the report's HTML file location.

Value

Path of the requested directory as a single-element character vector.

Author(s)

adapted by Fabian Mueller from RnBeads code by Yassen Assenov

See Also

Report for functions adding contents to an HTML report

Examples

1
2
report <- createReport("example.html", "Example", init.configuration = TRUE)
getReportDir(report, "data")

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