generate_levey_jennings_report {SerolyzeR} | R Documentation |
Generate a Levey-Jennings Report for Multiple Plates.
Description
This function generates a Levey-Jennings report for a list of plates. The report includes layout plot, levey jennings plot, for each analyte and selected dilutions.
Usage
generate_levey_jennings_report(
list_of_plates,
report_title,
dilutions = c("1/100", "1/400"),
filename = NULL,
output_dir = "reports",
additional_notes = NULL,
...
)
Arguments
list_of_plates |
A list of plate objects. |
report_title |
( |
dilutions |
( |
filename |
( |
output_dir |
( |
additional_notes |
( |
... |
Additional params passed to the plots created within the report. |
Details
The report also includes stacked standard curves plot in both monochromatic and color versions for each analyte.
The report is generated using the R Markdown template file
levey_jennings_report_template.Rmd
, located in the
inst/templates
directory of the package. You can access it using:
system.file("templates/levey_jennings_report_template.Rmd", package = "SerolyzeR")
.
Value
A Levey-Jennings report in HTML format.
Examples
output_dir <- tempdir(check = TRUE)
dir_with_luminex_files <- system.file("extdata", "multiplate_lite",
package = "SerolyzeR", mustWork = TRUE
)
list_of_plates <- process_dir(dir_with_luminex_files,
return_plates = TRUE, format = "xPONENT", output_dir = output_dir
)
note <- "This is a Levey-Jennings report.\n**Author**: Jane Doe \n**Tester**: John Doe"
generate_levey_jennings_report(
list_of_plates = list_of_plates,
report_title = "QC Report",
dilutions = c("1/100", "1/200"),
output_dir = tempdir(),
additional_notes = note
)