fl.report {QurvE} | R Documentation |
Create a PDF and HTML report with results from a fluorescence analysis workflow
Description
fl.report
requires a flFitRes
object and creates a report in PDF and HTML format that summarizes all results obtained.
Usage
fl.report(
flFitRes,
out.dir = tempdir(),
out.nm = NULL,
ec50 = FALSE,
format = c("pdf", "html"),
export = FALSE,
parallelize = TRUE,
...
)
Arguments
flFitRes |
A |
out.dir |
(Character) The path or name of the folder in which the report files are created. If |
out.nm |
Character or |
ec50 |
(Logical) Display results of dose-response analysis ( |
format |
(Character) Define the file format for the report, PDF ( |
export |
(Logical) Shall all plots generated in the report be exported as individual PDF and PNG files |
parallelize |
(Logical) Create plots using all but one available processor cores ( |
... |
Further arguments passed to create a report. Currently supported:
|
Details
The template .Rmd file used within this function can be found within the QurvE package installation directory.
Value
NULL
Examples
# load example dataset
## Not run:
input <- read_data(data.growth = system.file("lac_promoters_growth.txt", package = "QurvE"),
data.fl = system.file("lac_promoters_fluorescence.txt", package = "QurvE"),
csvsep = "\t",
csvsep.fl = "\t")
# Run workflow
res <- fl.workflow(grodata = input, ec50 = FALSE, fit.opt = 's',
x_type = 'time', norm_fl = TRUE,
dr.parameter = 'max_slope.spline',
suppress.messages = TRUE,
parallelize = FALSE)
fl.report(res, out.dir = tempdir(), parallelize = FALSE)
## End(Not run)