接收导入的数据

  1. 已经进行了峰提取的LC-MS数据(如采用XCMS, Progenesis QI或者Metaboscape)

  2. NMR原始图谱(Bruker格式)

  3. 靶标数据集(如采用Targetlynx, Bruker BI-LISA & BI-Quant-Ur获得的数据集)

工具箱的功能

  1. LC-MS数据集的批次或漂移矫正

  2. 通过相对标准偏差(RSD)或线性响应(linearity of response)进行信号过滤(Feature filtering)

  3. NMR中图谱线宽(line-width)的计算

  4. 数据集的PCA分析

  5. 数据集的可视化

输出格式

  1. csv文件

  2. ISA-TAB

安装

  1. 通过pip安装

  2. pip install nPYc

    通过源文件的本地副本,只需导航到主程序包所在的文件夹然后运行

python setup.py install
  1. 或者,使用pip和源文件的本地副本

pip install /nPYC-toolboxDirectory/
  1. pip的安装允许使用卸载命令

pip uninstall nPYc

相关文档

文档托管于Read the Docs

文档通过Sphinx Autodoc生成,文件的审订通过reStructuredText

在本地构建文档,cd到docs目录下,运行:

make html

清除当前文档,以便在进行更改后重新构建,运行:

make clean

开发

源管理是类似于git-flow,没有发展主分支。

在合并开发分支的时候,所有新的代码必须包括单元测试,应该通过所有测试,因为工具箱所有覆盖源不应该删除

释放

当从开发(或热修复分支)合并到发行版时,请确保:

  1. 删除对调试器的所有引用

  2. 所有路径都是相对的和平台无关的

  3. 所有测试通过

测试

单元测试通过unitest架构。测试覆盖可以在codecov.io寻找。

运行左右测试,cd到Tests,运行:

python -m unittest discover -v

可以使用单独的测试模块运行:

python -m `test_filename` -v

标准度量及编码

在内部存储时,除非显式覆盖,变量应该符合文档命名法中规定的单元