TidyMultiqc (version 1.0.3)

load_multiqc: Loads one or more MultiQC reports into a data frame

Description

Loads one or more MultiQC reports into a data frame

Usage

load_multiqc(
  paths,
  plots = NULL,
  find_metadata = function(...) {     list() },
  plot_parsers = list(),
  sections = "general"
)

Value

A tibble (data.frame subclass) with QC data and metadata as columns, and samples as rows. Columns are named according to the respective section they belong to, and will always be listed in the following order:

metadata.X

This column contains metadata for this sample. By default this is only the sample ID, but if you have provided the find_metadata argument, there may be more columns.

general.X

This column contains a generally useful summary statistic for each sample

plot.X

This column contains a data frame of plot data for each sample. Refer to the plot parsers documentation (ie the parse_X functions) for more information on the output format.

raw.X

This column contains a raw summary statistic or value relating to each sample

Arguments

paths

A string vector of filepaths to multiqc_data.json files

plots

A string vector, each of which contains the ID of a plot you want to include in the output. You can use list_plots() to help here.

find_metadata

A single function that will be called with a sample name and the parsed JSON for the entire report and returns a named list of metadata fields for the sample. Refer to the vignette for an example.

plot_parsers

Advanced. A named list of custom parser functions. The names of the list should correspond to plotly plot types, such as "xy_line", and the values should be functions that return a named list of named lists. For the return value, the outer list is named by the sample ID, and the inner list is named by the name of the column. Refer to the source code for some examples.

sections

A string vector of zero or more sections to include in the output. Each section can be:

"plot"

Parse plot data. Note that you should also provide a list of plots via the plots argument

"general"

parse the general stat section

"raw"

Parse the raw data section

This defaults to 'general', which tends to contain the most useful statistics

See Also

parse_xyline_plot() parse_bar_graph()

Examples

load_multiqc(system.file("extdata", "wgs/multiqc_data.json", package = "TidyMultiqc"))