绘图功能(Plotting functions)

https://npyc-toolbox.readthedocs.io/en/latest/plots.html

请参阅图片库gallery，以获得可用情节的可视化概述。

绘图plotting模块包含用于生成几种常见可视化的函数。

大多数绘图都支持一组通用配置参数，以允许定制各种显示选项。常用参数可以指定为关键字参数:

plottingFunctions(*vars, **kwatgs)

参数：

• savePath (str) – 如果none没有交互式绘图，则将图形保存到指定的路径。

• figureFormat (str) –如果保存图，使用这种格式

• dpi (int) – 图片分辨率

• figureSize (tuple(float**, float**)) -图片尺寸

交互式绘图利用plotly框架提供控件，在使用plotly时，应确保环境按照Python plotly 中的脱机绘图说明配置

1. nPYc.plotting.histogram(values, inclusionVector=None, quantiles=None, histBins=100, color=None, logy=False, logx=False, **kwargs)

   绘制一种值的直方图，可根据观察到的分位数进行任意分割

   可以在指定的第二个包含向量上计算分位数

   参数：

   • values (numpy.array or dict) – 值

   • inclusionVector (None or numpy.array) – 与值大小相同的可选第二向量，用于选择用于绘图的分位数

   • quantiles (None or List) – 分位数列表以分段直方图为界

   • title (str) – 图片名称

   • xlabel (str) – X轴名称

   • histBins (int) – 将直方图分成多少个箱子

   • color (None or List) – 用于绘图的特定颜色列表

   • logy (bool) – 如果true，Y轴取对数

   • logx (bool) – 如果true，X轴取对数

   • xlim (tuple of int) – 指定X轴的上下界

2. nPYc.plotting.plotBatchAndROCorrection(msData, msDatacorrected, featureList, addViolin=True, sampleAnnotation=None, logy=False, title='', savePath=None, figureFormat='png', dpi=72, figureSize=(11, 7))

   通过绘制校正前和校正后的值以及拟合计算值，可视化应用于特征的运行顺序校正

   参数：

   • msData (MSDataset) – 校正前的数据集

   • msDatacorrected (MSDataset) – 校正后的数据集

   • featureList (list[int,]) – 指定要绘图的特性索引的列表

   • addViolin (bool) – 若为True，则曲线分布除为小提琴曲线外的纵向趋势

   • sampleAnnotation (dict) – 图中标注的示例，must include fields ‘rank’: index (int) and ‘id’: sample name (str, as in msData.sampleMetadata[‘Sample File Name’]). For example, item[‘AbundanceSamples’] in featureID.py.

   • logy (bool) – 若为True，图的强度取log10

   • title (str) – 文本标题

   • savePath (None or str) – 如果没有交互式绘图none，则将图形保存到指定的路径

3. nPYc.plotting.plotTIC`(msData, addViolin=True, addBatchShading=False, addLineAtGaps=False, colourByDetectorVoltage=False, logy=False, title='', withExclusions=True, savePath=None, figureFormat='png', dpi=72, figureSize=(11, 7))

   可视化TIC的全部或部分特征，由稀释值或检测器电压着色。可选择批量着色。

   注意：addViolin与colourByDetectorVoltage相互排斥

   参数：

   • msData (MSDataset) – 数据集

   • addViolin (bool) – 如果True，根据样本类型，添加TIC分布前后校正分割的小提琴图

   • addBatchShading (bool) – 如果True,根据样品批次绘制阴影图

   • addLineAtGaps (bool) – 如果True，在获取时间大于正常时间两倍的地方添加行

   • colourByDetectorVoltage (bool) – 如果True，颜色点由检测器电压决定，否则由稀释决定颜色

   • logy (bool) – 若为True，图的强度取log10

   • title (str) – 文本标题

   • withExclusions (bool) – 如果False，从sum中删除屏蔽特性

   • savePath (None or str) – 如果没有交互式绘图none，则将图形保存到指定的路径

   • figureFormat (str) – 如果保存图，使用这种格式

   • dpi (int) – 图片分辨率

   • figureSize (tuple(float**, float**)) -图片尺寸

4. nPYc.plotting.plotTICinteractive`(msData, plottype='Sample Type')

   交互式地可视化(由批次和样品类型着色)与绘图，提供工具提示，以允许鉴定样品。

   图可分为两类:“样本类型Sample Type”按样本类型绘图，而“批次”“线性参考Linearity Reference”按稀释颜色绘图

   参数：

   • msData (MSDataset) – 数据集

   • plottype (str) – 图片种类，Sample Type或者Linearity Reference

   返回：

   数据对象与绘图一起使用

5. nPYc.plotting.plotLRTIC`(msData, sampleMask=None, colourByDetectorVoltage=False, title='', label=False, savePath=None, figureFormat='png', dpi=72, figureSize=(11, 7))

   线性参考(LR)样品(全部或部分)由稀释值或检测器电压着色。

   参数：

   • msData (MSDataset) – 数据集

   • sampleMask (None or array of bool) – 如果没有使用msData的内置sampleMask，则定义要绘图的样本子集

   • colourByDetectorVoltage (bool) – 如果True，颜色点由检测器电压决定，否则由稀释决定颜色

   • title (str) – 文本标题

   • label (bool) – 如果True，带有运行顺序值的标签点

   • savePath (None or str) – 如果没有交互式绘图none，则将图形保存到指定的路径

   • format (str) – 保存图形的格式

   • dpi (int) – 图片的分辨率

   • figureSize (tuple(float**, float**)) –图片尺寸

6. nPYc.plotting.jointplotRSDvCorrelation`(rsd, correlation, histBins=100, savePath=None, figureFormat='png', dpi=72, figureSize=(11, 7))

   用边缘直方图绘制特征RSDs与稀释相关的2D直方图。

   参数：

   • rsd (numpy.array) – 特征相对标准差的向量

   • correlation (numpy.array) – 与稀释相关的向量

   • histBins (int) – 将直方图分成多少个箱子

   • savePath (None or str) – 如果没有交互式绘图none，则将图形保存到指定的路径

   • figureFormat (str) – 如果保存图，使用这种格式

   • dpi (int) – 图片的分辨率

   • figureSize (tuple(float**, float**)) –图片尺寸

7. nPYc.plotting.plotCorrelationToLRbyFeature`(msData, featureMask=None, title='', maxNo=5, savePath=None, figureFormat='png', dpi=72, figureSize=(11, 7))

   一小部分特征的稀释相关关系的汇总图，以样本批次分隔。每个图包括特征强度vs稀释的散点图，LR和周围SP样本的TIC图，以及每个LR批子集的总体和平均值与稀释的相关热图

   参数：

   • msData (MSDataset) – 数据集

   • featureMask (None or array of bool) – 如果没有人使用msData的内置sampleMask，则限制绘图到功能的子集

   • title (str) – 文本标题

   • maxNo (int) – 可选的功能数目绘图(default=10, i.e., 将绘制featureList中随机选取的10个特征)

   • savePath (None or str) – 如果没有交互式绘图none，则将图形保存到指定的路径

   • figureFormat (str) – 如果保存图，使用这种格式

   • dpi (int) – 图片的分辨率

   • figureSize (tuple(float**, float**)) –图片尺寸。

8. nPYc.plotting.plotIonMap`(msData, useRetention=True, title=None, savePath=None, xlim=None, ylim=None, logx=False, logy=False, figureFormat='png', dpi=72, figureSize=(11, 7))

   plotIonMap(msData, **kwargs):

   可视化MSDataset中的特性，以可视化原始数据的特性。

   绘图需要在featureMetadata表中显示“m/z”和“保留时间”列。如果存在“m/z”和保留时间，则生成2D离子映射，否则绘制1D质谱。

   参数：

   • msData (MSDataset) – 要可视化的数据集

   • useRetention (bool) –如果False，则忽略保留时间信息，绘制1D质朴图

9. nPYc.plotting.plotRSDs`(dataset, ratio=False, savePath=None, color=None kwargs)

   可视化分析和生物差异。

   图RSDs计算的研究参考样本(分析方差)，与那些计算的研究样本(生物方差)。RSDs可以用绝对值来表示，也可以用分析变异的比率表示(比率=True)。

   plotRSDs()要求数据集至少有两个具有精确参照(PrecisionReference)分析功能的样本，如果存在，还会绘制基于独立的精确参照样本集PrecisionReference计算的RSDs

   参数：

   • dataset (Dataset) – 要绘制数据集对象，对象必须有一个更大的“研究样本”和“研究参考样本”定义

   • ratio (bool) – 如果True绘制分析方差与生物方差之比，而不是原始值

   • logx (bool) – 如果True,绘制对数的RSDs图

   • xlim (None or tuple(float**, float**)) – 要绘制的元组(最小，最大值)RSD值

   • savePath (None or str) – 如果没有交互式绘图none，则将图形保存到指定的路径

   • color (None or seaborn.palettes._ColorPalette) – 允许覆盖默认颜色的托盘

   • featName (bool) –如果Truey轴标签是特征名称，如果False特征编号。

10. nPYc.plotting.plotRSDsInteractive`(dataset, ratio=False, logx=True)

    可视化分析和生物差异。

    plotRSDsInteractive()要求数据集至少有两个具有精确参照(PrecisionReference)分析功能的样本，如果存在，还会绘制基于独立的精确参照样本集PrecisionReference计算的RSDs

    参数：

    • dataset (Dataset) – 要绘制数据集对象，对象必须有一个更大的“研究样本”和“研究参考样本”定义

    • ratio (bool) – 如果True绘制分析方差与生物方差之比，而不是原始值

    • logx (bool) – 如果True,绘制对数的RSDs图

11. nPYc.plotting.`plotScree(R2, Q2=None, title='', xlabel='', ylabel='', savePath=None, figureFormat='png', dpi=72, figureSize=(11, 7))

    绘制每个PCA组件的方差解释(R2)和预测(Q2)的条形图。

    参数：

    • R2 (numpy.array) – PCA R2值

    • Q2 (numpy.array) – PCA Q2值

    • title (str) – 文本标题

    • xlabel (str) – x轴标签

    • ylabel (str) – y轴标签

12. nPYc.plotting.plotOutliers`(values, runOrder, sampleType=None, addViolin=False, Fcrit=None, FcritAlpha=None, PcritPercentile=None, title='', xlabel='Run Order', ylabel='', savePath=None, figureFormat='png', dpi=72, figureSize=(11, 7))

    PCA异常值统计总和(强)或DmodX(中等)的散点图，分位数为[25,50,75,95,99]，如果指定为临界值

    参数：

    • values (numpy.array) – dModX或分数的总和，衡量每个样本的“适合度”

    • runOrder (numpy.array) – 样本采集顺序(样本按此顺序绘制)

    • sampleType (pandas.Series) – 每个样本的样本类型，必须来自' Study Sample '， ' Study Pool '， ' External Reference '，或' Sample '(参见multivariateReport.py)

    • addViolin (bool) –如果True,加了小提琴的值分布图

    • Fcrit (float) –如果none，在Fcrit上画一条线

    • FcritAlpha (float) –Fcrit的Alpha值(对于图例)

    • PcritPercentile (float) – 如果none的话，在这个分位数上画一条线

    • title (str) – 文本标题

    • xlabel (str) – x轴标签

13. nPYc.plotting.plotSpectralVariance`(dataset, classes=None, quantiles=(25, 75), average='median', xlim=None, **kwargs)

    绘制数据集的平均光谱剖面图，可选择用阴影下的分位数计算出的方差边界。通过从数据集中指定一个列。sampleMetadata在classes参数中，将为dataset.sampleMetadata[classes]中的每个惟一标签绘制单个平均值和范围。

    参数：

    • dataset (Dataset) – 绘图的数据集

    • classes (None or column in dataset.sampleMetadata) – 按指定的不同类进行绘图

    • quantiles (None or (min, max**)) – 画出这些分位数的边界

    • average (str) – 计算平均光谱的方法，默认为“中位数”，也可能是“平均”

    • xlim (None or (float, float**)) – 将x轴缩放为(最小，最大值)的元组值

    • logy (bool) – 如果True,图形强度在log10尺度上

    • title (str) – 文本标题

14. nPYc.plotting.plotScores`(pcaModel, classes=None, classType=None, components=None, alpha=0.05, plotAssociation=None, title='', xlabel='', figures=None, savePath=None, figureFormat='png', dpi=72, figureSize=(11, 7))

    绘制PCAmodel中每一对组件的PCA得分，由类中定义的值着色，并使用Hotelling的T2椭圆(95%)。

    参数：

    • pcaModel (ChemometricsPCA) – PCA模型对象(基于scikit-learn)

    • classes (pandas.Series) – 与每个样本相关的测量/分组，如BMI/治疗状态

    • classType (str) – 如果类不是None，则必须指定类中的数据类型，如“Plot Sample Type”、“categorical”或“continuous”。如果classType是“Plot Sample Type”，那么类需要“Study Sample”、“Study Pool”、“External Reference”、“linear Reference”或“Sample”。

    • components (tuple (int, int**)) – 如果模型中没有绘制所有成分，否则将绘制组件中指定的成分。

    • alpha (float) –Hotellings椭圆标绘的显著性值

    • plotAssociation (bool) – 如果True，绘制每组PCA得分与元数据值之间的关联

    • significance (numpy.array) – 例如，将每个组件的得分与来自相关或Kruskal-Wallis测试的类中的值关联的重要性(请参阅multivariateReport.py)

    • title (str) – 图片的名称

    • xlabel (str) – X轴名称

    • figures (dict) – 如果不是，则保存每个图形的位置，以便在html报告中输出(参见multivariateReport.py)

15. nPYc.plotting.plotScoresInteractive`(dataTrue, pcaModel, colourBy, components=[1, 2], alpha=0.05, withExclusions=False)

    交互式地用plotly可视化PCA得分(由给定的sampleMetadata字段和给定的一对组件着色)，提供工具提示以允许识别样本。

    参数：

    • dataTrue (Dataset) – 数据集

    • object pcaModel (PCA) – PCA模型对象(基于scikit-learn)

    • colourBy (str) – sampleMetadata字段的名称，其中值的颜色样本通过

    • components (list) – 两个整数的列表，要绘图的成分

    • alpha (float) –Hotellings椭圆标绘的显著性值

    • withExclusions (bool) – 如果True，只报告未被样本和特征掩码掩盖的特征和样本;数据和pcaModel必须匹配

16. nPYc.plotting.plotLoadings`(pcaModel, msData, title='', figures=None, savePath=None, figureFormat='png', dpi=72, figureSize=(11, 7))

    参数：

    • pcaModel (ChemometricsPCA) –PCA模型对象(基于scikit-learn)

    • msData (Dataset) – 数据集

    • title (str) – 图片的名称

    • figures (dict) – 如果不是，则保存每个图形的位置，以便在html报告中输出(参见multivariateReport.py)

17. nPYc.plotting.plotLoadingsInteractive`(dataTrue, pcaModel, component=1, withExclusions=False)

    交互式地可视化PCA加载(对于给定的一对组件)，提供工具提示以允许识别特性。

    对于MS数据，绘制RT与mz图;对于核磁共振绘制ppm和光谱强度。图上的颜色是由载荷的重量决定的。

    参数：

    • dataTrue (Dataset) – 数据集

    • pcaModel (ChemometricsPCA) –PCA模型对象(基于scikit-learn)

    • components (list) – 两个整数的列表，要绘图的成分

    • withExclusions (bool) – 如果True，只报告未被样本和特征掩码掩盖的特征和样本;数据和pcaModel必须匹配

18. nPYc.plotting.plotDiscreteLoadings`(pcaModel, nbComponentPerRow=3, firstComponent=1, sort=True, **kwargs)

    作为一组平行垂直散布图的线性模型的绘图负载。

    参数：

    • pcaModel (ChemometricsPCA) –PCA模型对象(基于scikit-learn)

    • nbComponentPerRow (int) – 每行放置并排装载图的数量

    • firstComponent (int) –从这个组件开始绘制组件

    • sort (bool) – 根据分量1的大小绘制变量

19. nPYc.plotting.plotFeatureRanges`(dataset, compounds, logx=False, histBins=20, **kwargs)

    将化合物中列出的值绘制成图分布图，绘制在具有相连x轴的一组轴上。

    如果在featureMetadata中指定了引用范围，那么将在每个图后面绘制一个引用范围。如果参考范围可用，在范围内的分布将用绿色表示，在没有参考范围的情况下，分布将用蓝色表示。

    参数：

    • dataset (Dataset) – 绘图的数据集

    • components (list) – 要绘图的成分

    • logx (bool) – 在log10尺度上计算和绘制直方图，如果最小值小于1，则通过对所有值加1计算直方图

    • histBins (int) – 用于柱状图的容器数

20. nPYc.plotting.plotMetadataDistribution`(sampleMetadata, valueType, figures=None, savePath=None, figureFormat='png', dpi=72, figureSize=(11, 7))¶

    绘制一组数据的分布，例如sampleMetadata字段。为分类数据绘制条形图，或为连续数据绘制直方图。

    参数：

    • sampleMetadata (dataset.sampleMetadata) – 与每个示例相关联的度量/分组的集合，注意可以包含多个列，但它们必须是一个valueType

    • valueType (str) – sampleMetadata中包含的数据类型，连续、分类或日期之一

    • figures (dict) – 如果不是None，则保存每个图形的位置，以便在html报告中输出(参见multivariateReport.py)

21. nPYc.plotting.plotLOQRunOrder`(targetedData, addCalibration=True, compareBatch=True, title='', savePath=None, figureFormat='png', dpi=72, figureSize=(11, 7))

    按运行顺序将LLOQ和ULOQ的可视化比率按批量分开。选项可添加在批处理中汇总的条形图

    参数：

    • targetedData (TargetedDataset) – targetedData数据集

    • addCalibration (bool) – 如果True，添加校准样品

    • compareBatch (bool) – 如果True，通过批量添加条形图，用SampleType分隔

    • title (str) – 图片名称

    • savePath (None or str) –如果没有交互式绘图none，则将图形保存到指定的路径

    • figureFormat (str) – 如果保存图，使用这种格式

    • dpi (int) – 图片的分辨率

    • figureSize (tuple(float**, float**)) –图片尺寸。

    提升:

    • ValueError – 如果targetedData不满足QC的TargetedDataset定义

    • ValueError – 如果targetedData不满足QCif校准的TargetedDataset定义，则不匹配批号

22. nPYc.plotting.plotFeatureLOQ`(tData, splitByBatch=True, plotBatchLOQ=False, zoomLOQ=False, logY=False, tightYLim=True, nbPlotPerRow=3, metabolitesPerPlot=5, withExclusions=True, savePath=None, figureFormat='png', dpi=72, figureSize=(11, 7))

    小提琴的每一个特征与线在LOQ浓度。选择按批分割，添加每个批loq，按SampleType分割。

    参数：

    • tData (TargetedDataset) – TargetedDataset

    • splitByBatch (bool) – 如果True, 要分批分开每一个小提琴情节

    • plotBatchLOQ (bool) – 如果True，在LOQ (LLOQ/ULOQ)上为每个批次添加行，并为LOQ之外的样品添加点

    • zoomLOQ (bool) –如果真绘制了顶部放大的ULOQ图，则所有数据都在中心，底部放大的LLOQ图

    • logY (bool) – 如果True，对数刻度y轴

    • tightYLim (bool) – 如果True，ylim是接近点但可以让LOQ线外，如果假LOQ线将是情节的一部分

    • nbPlotPerRow (int) – 每行要放置的绘图数

    • metabolitesPerPlot (int) –最大数量的代谢物绘制在单一数字

    • savePath (None or str) –如果没有交互式绘图none，则将图形保存到指定的路径

    • figureFormat (str) – 如果保存图，使用这种格式

    • dpi (int) – 图片的分辨率

    • figureSize (tuple(float**, float**)) –图片尺寸。

    提升:

    • ValueError – 如果targetedData不满足QC的TargetedDataset定义

23. nPYc.plotting.plotVariableScatter`(inputTable, logX=False, xLim=None, xLabel='', yLabel='', sampletypeColor=False, hLines=None, hLineStyle='-', hBox=None, vLines=None, vLineStyle=':', vBox=None, savePath=None, figureFormat='png', dpi=72, figureSize=(11, 7))

    在x轴上绘制值，在y轴上排序。行放在x轴上时，所有列的值用不同的颜色标在y轴上。如果sampletypeColor=True，则只绘制名为SampleTypes的列，并根据其他报告着色，否则绘制所有列。行顺序保持不变，第一个项放在y轴的顶部，最后一行在底部。如果存在列[' yName ']，则使用它来标记每个y轴条目。

    参数：

    • inputTable (dataframe) –DataFrame或accuracy或precision值，特征为行，样本类型为列([' Study sample '， ' Study Pool '， ' External Reference '， ' All Samples '， ' nan '])。可以出现“yName”列来显示功能名称。每个轴条目。

    • logX (bool) – 如果在log10缩放x轴上的真实绘图值

    • xlim (None or (float, float**)) – 将x轴缩放为(最小，最大值)的元组值

    • xLabel (str) – X轴标签

    • yLabel (str) – Y轴标签

    • sampletypeColor (bool) –如果为True，则仅用与其他报表匹配的颜色绘制sampleType列

    • hLines (None or list) –没有或没有y位置的列表来绘制水平线。功能定位从1到n

    • hLineStyle (str) –一种轴索线型(‘-‘, ‘–’, ‘-.’, ‘:’)

    • hBox (None or list) – 没有定义水平框的y位置元组或列表。功能定位从1到n

    • vLines (None or list) – 没有或列出要绘制垂直线的v个位置。单位等于v轴。

    • vLineStyle (str) – 一种轴索线型(‘-‘, ‘–’, ‘-.’, ‘:’)

    • vBox (None or list) – 没有或没有x位置的列表来绘制垂直线。功能定位从1到n

    • color (None or seaborn.palettes._ColorPalette) – 允许覆盖默认颜色的托盘

    • savePath (None or str) –如果没有交互式绘图none，则将图形保存到指定的路径

24. nPYc.plotting.plotAccuracyPrecision`(tData, accuracy=True, percentRange=None, savePath=None, figureFormat='png', dpi=72, figureSize=(11, 7))

    目标数据集的绘图精度或精度。

    所有当前浓度的特征都显示在y轴上，精度或精度值显示在x轴上。准确率在100%左右。如果精度值覆盖范围太广，则x轴被对数转换。

    参数：

    • tData (TargetedDataset) – 绘图的TargetedDataset对象

    • accuracy (bool) – 如果为True，绘制每个测量的准确性；如果为False则绘制测量精度。

    • percentRange (None or float) –如果float [0, inf]，添加一个覆盖可接受百分比范围的矩形;对于精度100 +/-百分比，对于精度0 -百分比。

    • savePath (None or str) –如果没有交互式绘图none，则将图形保存到指定的路径

    • figureFormat (str) – 如果保存图，使用这种格式

    • dpi (int) – 图片的分辨率

    • figureSize (tuple(float**, float**)) –图片尺寸。

    提升

    • ValueError – 如果targetedData不满足QC的TargetedDataset定义

    • ValueError – 如果targetedData不满足QCif校准的TargetedDataset定义，则不匹配批号

25. nPYc.plotting.plotIonMapInteractive`(dataset, title=None, xlim=None, ylim=None, logx=False, logy=False, featureName='Feature Name')

    将MSDataset中的特性可视化为一个离子映射。

    绘图需要在featureMetadata表中显示“m/z”和“保留时间”列。

    参数：

    • msData (MSDataset) – 可视化的数据集

26. nPYc.plotting.plotSpectralVarianceInteractive`(dataset, classes=None, quantiles=(25, 75), average='mean', xlim=None, title=None)

    绘制数据集的平均光谱剖面图，可选择用阴影下的分位数计算出的方差边界。通过从数据集中指定一个列。sampleMetadata在classes参数中，将为dataset.sampleMetadata[classes]中的每个惟一标签绘制单个平均值和范围。

    参数：

    • dataset (Dataset) – 绘图的数据

    • classes (None or column in dataset.sampleMetadata) – 按指定的不同类进行绘图

    • quantiles (None or (min, max**)) –画出这些分位数边界

    • average (str) – 计算平均光谱的方法，默认为“中位数”，也可能是“平均”

    • xlim (None or (float, float**)) – 将x轴缩放为(最小，最大值)的元组值

27. nPYc.plotting.correlationSpectroscopyInteractive`(dataset, target, mode='SHY', correlationMethod='Pearson')

    对数据集中的样品进行相关谱分析。

    模式可能是:-SHY关联特征在数据集与目标值

    参数：

    • dataset (Dataset) – 绘图的数据

    • target (numpy.array) –计算相关系数

    • mode (str) – 要进行的分析类型

    • correlationMethod (str) – 要计算的相关类型可能是“pearson”或“Spearman”