| render | R Documentation |
Writes a quality-control report with Quarto.
The report starts with a cover that gives the study details.
Then comes a decision summary, with the flagged samples and notes on how
the data were processed.
A table gives each setting and limit, with its meaning and its source.
Each plot of autoplot() and each table has a short "How to read this".
A methods appendix gives the citation and the package versions.
render(
x,
format = c("html", "typst"),
output_dir = ".",
colour = "CartridgeID",
group = NULL,
size = 1,
show_legend = TRUE,
outliers_factor = 1,
outliers_labels = NULL,
title = NULL,
author = NULL
)
x |
A |
format |
|
output_dir |
The directory to write |
colour |
The column of |
group |
The column of |
size |
The point size. |
show_legend |
If |
outliers_factor |
The size of flagged samples, relative to |
outliers_labels |
The column of |
title |
The report title.
|
author |
Who prepared the report, as one string, for example
|
The report needs the Quarto command-line interface 1.9.18 or newer, and the quarto, knitr and rmarkdown packages. RStudio and Positron bundle Quarto; elsewhere, install it from https://quarto.org/docs/get-started/. The PDF goes through Typst, which Quarto bundles, so no LaTeX is needed.
The PDF is tagged and declares PDF/UA-1. When Typst compiles the PDF, it checks the PDF/UA-1 rules that it can enforce. When Quarto shows the warning "verapdf is not installed", you can ignore it: it only means that Quarto did not do the extra validation step.
The path of the report, invisibly.
if (interactive()) {
data(GSE74821)
render(GSE74821, output_dir = tempdir())
render(GSE74821, format = "typst", output_dir = tempdir())
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.