TidyMultiqc (version 1.0.3)

list_plots: List the plot identifiers of all the plots in a given multiqc report

Description

List the plot identifiers of all the plots in a given multiqc report

Usage

list_plots(path)

Value

A data frame containing \(n\) rows, where \(n\) is the number of plots in the report you have provided, and two columns:

id

The identifier for the plot. This is the one you should use as a name in plot_opts.

name

The plot title. This is likely what you see in the multiqc report when you open it with your browser.

Arguments

path

The file path to the multiqc report. This should be a length 1 character vector

Details

The main use for this function is finding the plot identifiers that you will then pass into the plots argument of the load_multiqc() function. Refer to the section on "Extracting Plot Data" in the main vignette for more information.

Examples

# Ignore this, choose your own filepath as the `filepath` variable
filepath <- system.file("extdata", "HG00096/multiqc_data.json", package = "TidyMultiqc")
# This is the actual invocation
list_plots(filepath)