GenerateQCPlots: Generate quality control plots for mz pair candidates.

View source: R/GenerateQCPlots.R

GenerateQCPlotsR Documentation

Generate quality control plots for mz pair candidates.

Description

GenerateQCPlots will produce QC plots for a list containing test results objects (generated by EvaluateCandidateListAgainstRawData.

Usage

GenerateQCPlots(
  res_list = NULL,
  pdf_file = NULL,
  mfrow = NULL,
  skip_plots = NULL
)

Arguments

res_list

A list of result objects (each testing an individual mz pair).

pdf_file

The path to a writable file.

mfrow

If NULL automatically determined, otherwise useful to specify a layout.

skip_plots

NULL or numeric vector in which case plots with numbers in skip_plots will be empty.

Details

If you provide a single candidate (list of length = 1) an output to a screen plotting device is reasonable, otherwise a target PDF file should be specified in parameter 'pdf_file'.

Value

Figure output.

Examples

## Not run: 
  # load evaluation result of example data
  data(res_list)
  # generate Figures on screen (use PDF output for multiple candidates)
  GenerateQCPlots(res_list[1])

## End(Not run)


HiResTEC documentation built on April 3, 2025, 9:35 p.m.