Skip to contents

FastQC-viz: Create FastQC-viz report

Source: R/create_fastqcviz_report.R
create_fastqcviz_report.Rd

Create the FastQC-viz report. FastQC-viz contain all FastQC plots and basic statistics but with some design improvements.

Usage

create_fastqcviz_report(
  fastqc_path,
  output_dir = "fastqcviz_report",
  embed_resources = FALSE,
  add_help = TRUE
)

Arguments

fastqc_path

character, path to fastqc_data.txt file

output_dir

character, output directory

embed_resources

boolean, TRUE to embed resources into the HTML

add_help

boolean, TRUE to add help sections

Value

NULL, create output_dir with the report (index.html)

Examples

my_temp_dir <- paste0(tempdir(),"/fastqcviz_report")
create_fastqcviz_report(
    fs::path_package("extdata", "SRR622457_2_fastqc.txt", package = "fastqcviz"),
    output_dir = my_temp_dir,
    embed_resources = FALSE)
cat("Files created in", my_temp_dir)
#> Files created in /tmp/Rtmpz8PJzR/fastqcviz_report