MSI_ionStatPlot {MSImaging} R Documentation

Stat plot combine with the MS-imaging

Description

Usage

MSI_ionStatPlot(mzpack, mz, met, sampleinfo,
    savePng = './Rplot.png',
    ionName = NULL,
    size = [1000],
    colorMap = NULL,
    MSI.colorset = 'viridis:turbo',
    ggStatPlot = NULL,
    padding.top = 150,
    padding.right = 200,
    padding.bottom = 150,
    padding.left = 150,
    interval = 50,
    combine.layout = [5],
    jitter.size = 8,
    TrIQ = 0.65,
    backcolor = 'black',
    regions = NULL);

Arguments

mzpack

a mzpack data object used for do MS-imaging or other data object that contains the ms-imaging layer data and could be recognized by the ggplot ms-imaging function.

ionName

the display title string. the ion m/z value will be used if this parameter leaves default NULL.

mz

the target ion m/z value.

met

should be a list data object that contains the sample data, which this list the key names is the sample id set and the corresponding element value is the sample intensity value.

sampleinfo

a data list set which could be used for defined the sample group information and the plot color value. this list data should be contains at least 3 required data fields: 1. group: the sample group name, used for display as the title label of each group data 2. id: a character vector that contains the necessary sample id reference to get the required sample data for each data group 3. color: a single character string value in html color format for specific the color of the bar/box/violin stat plot.

colorMap

a list object that contains the color set value that used for rendering the stat chartting, example as box/bar/violin. this list data object the key names should be the sample group tag and the corresponding value must be the sample intensity data value.

MSI.colorset

the color map name for do MS-imaging rendering, default color scale name is viridis:turbo.

ggStatPlot

default is bar plot.

combine.layout

the layout of the stat charting and the MS-imaging plot. a numeric vector that contains two value element, first is the width percentage of the stats chart and the second one is the width percentage of the single ion ms-imaging.

savePng

the filepath to save the image plot output.

backcolor

the background color of the MS-imaging plot

Details

Authors

xieguigang

Value

This function has no value returns.

Examples


[Package MSImaging version 0.1.0 Index]