RiverPlot {MSstatsQC} | R Documentation

## A function to create river plot to aggregate results from X and mR charts or CUSUMm and CUSUMv charts.

### Description

A function to create river plot to aggregate results from X and mR charts or CUSUMm and CUSUMv charts.

### Usage

    RiverPlot(
      data = NULL,
      L = 1,
      U = 5,
      method = "XmR",
      listMean = NULL,
      listSD = NULL
    )

### Arguments

`data` | omma-separated (.csv), metric file. It should contain a "Precursor" column and the metrics columns. It should also include "Annotations" for each observation.
`L` | lower bound of the guide set.
`U` | upper bound of the guide set.
`method` | defines the method selected to construct control charts.
`listMean` | list of the means for each metric. It is used when mean is known. It is NULL when mean is not known. The default is NULL.
`listSD` | list of the standard deviations for each metric. It is used when standard deviation is known. It is NULL when mean is not known. The default is NULL.

### Value

A river plot to aggregate results per metric generated from `XmR.Summary.DataFrame` data frame or `CUSUM.Summary.DataFrame` data frame.

### Examples

    # First process the data to make sure it's ready to use
    sampleData <- DataProcess(S9Site54)
    head(sampleData)
    # Draw XmR summary plot
    RiverPlot(data = sampleData)
    RiverPlot(data = sampleData, L=1, U=20, method = "XmR",
                    listMean = list("BestRetentionTime" = 27.78,
                                    "TotalArea" = 35097129,
                                     "MaxFWHM" = 0.28,
                                     "MinStartTime" = 24),
                    listSD = list("BestRetentionTime" = 8.19,
                                  "TotalArea" = 34132861,
                                  "MaxFWHM" = 0.054,
                                  "MinStartTime" = 24)
                    )

[Package MSstatsQC version 2.10.0 Index]