代谢组学数据聚类和树状图绘制软件包
BioDendro的Python项目详细描述
生物树突
a包,用于对代谢组学数据进行聚类,并绘制树状图
背景
- 项目负责人:凯瑟琳·罗林森(博士生)
- 电子邮件:catherine.rawlinson@postgrad.curtin.edu.au
将MGF格式和组件列表转换为非冗余列表。 将组分分析物列表转换为数据矩阵,对分析物进行动态组合和聚类。
从bash在linux或mac上安装
使用pip安装最简单。 假设您安装了python3,那么可以运行以下命令进行安装。
python3 -m pip install --user biodendro # or git clone git@github.com:CurtinIC/BioDendro.git &&cd BioDendro python3 -m pip install --user biodendro
--user
标志告诉pip安装到用户目录而不是系统目录。
对于Mac和Linux,这通常在~/.local
下。
如果是这种情况,请确保将~/.local/bin
添加到$PATH
中。
对于更高级的用户,我们建议使用virtual environment或conda environment。
要以根用户身份安装,可以省略--user
,但通常不建议这样做。
sudo python3 -m pip install biodendro
要安装最新和最好的版本,可以使用git,直接从存储库安装。
python3 -m pip install --user git+https://github.com/CurtinIC/BioDendro.git # or git clone git@github.com:CurtinIC/BioDendro.git &&cd BioDendro python3 -m pip install --user .
BioDendro
脚本和python包现在都可以使用(假设python配置正确)。
快速入门示例-命令行
最快的运行方式是使用命令行界面。
可以使用--help
标志获得选项列表。
BioDendro --help
要使用示例mgf和组件文件运行基本管道,请执行以下操作:
BioDendro --results-dir my_results_dir MSMS.mgf component_list.txt
快速入门示例-python库
管道也可用作python函数/库。 上面的命令相当于python中的以下命令。
importBioDendrotree=BioDendro.pipeline("MSMS.mgf","component_list.txt",results_dir="my_results_dir")
从那里您可以分析存储在tree
中的结果。
jupyter笔记本的例子包含了对不同参数的更详细的解释。
quick-start-example.ipynb包含有关运行管道的基本信息。
longer-example.ipynb包含有关管道如何工作以及如何修改参数的更详细信息。
命令行api
管道也可以从bash或类似bash的终端运行。 如果您不打算对参数进行太多调整,而只想运行该死的东西,那么这非常有用。
对于这些示例,我们使用ipython magic命令%%bash
在bash中运行这些命令。
如果在终端中直接运行,则可以省略%%bash位。
要获取所有可用选项的列表,请使用--help
(或-h
)标志。
%%bash BioDendro --help
运行管道的最小选项是mgf文件和组件列表。
使用biodendro repo中的示例数据,我们可以运行…
%%bash BioDendro MSMS.mgf component_list.txt
与以前一样,结果将存储在一个目录中,当前日期和当前时间将添加到该目录的末尾。
您可以通过提供额外的标志来更改要使用的参数,但是,这将再次运行整个管道,因此您只需要调整截止值或决定使用braycurtis而不是jaccard距离,最好使用python api。
%%bash
BioDendro --scaling --cluster-method braycurtis --cutoff 0.5 MSMS.mgf component_list.txt
相当于在python中运行以下命令
tree=BioDendro.pipeline("MSMS.mgf","component_list.txt",clustering_method="braycurtis",scaling=True,cutoff=0.5)