Skip to main content

使用 CFM-ID 的 Python 包装器:https://cfmid.wishartlab.com

项目描述

CFM-ID Python 包

此包是使用 CFM-ID 的 Python 包装器:https ://cfmid.wishartlab.com

CFM-ID 提供了一种准确有效地识别由电喷雾串联质谱 (ESI-MS/MS) 生成的光谱中的代谢物的方法。该程序使用竞争性碎片建模为 MS/MS 碎片过程生成概率生成模型,并使用机器学习技术从数据中调整模型参数。

此软件包正在开发中,仅适用cfm-predict于 CFM-ID 2.0 版。

安装

pip install cfm-id

用法

from cfm_id import CfmId

cfm_id = CfmId("/path/to/cfm_id/folder")
cfm_id.predict("O=C1OC(CO)C(O)=C1O")

默认输出格式是 MatchMS 列表Spectrum,包括 3 种能量的“合并”光谱。

您可以使用参数指定 CFM-ID 原始文本格式导出raw_format

cfm_id.predict("O=C1OC(CO)C(O)=C1O", raw_format=True)

环境变量

您还可以使用环境变量CFMID_PATH而不是路径参数。

export CFMID_PATH=path/to/cfm_id/folder
from cfm_id import CfmId

cfm_id = CfmId()

参数和配置文件

默认情况下,CfmId将使用位于 cfm_id 文件夹根目录的文件分别作为参数和配置文件param_output.log 。param_config.txt

您可以在实例化时使用本地路径作为字符串的 ist 指定另一个文件位置:

from cfm_id import CfmId

cfm_id = CfmId(
    "/path/to/cfm_id/folder",
    param=["param", "param_output0_neg.log"], conf=["conf", "param_config_neg.txt"]
)

在此示例中,cfm_id实例将/path/to/cfm_id/folder/param/param_output0_neg.log 用作参数文件。

使用 Docker 镜像

您可以通过使用CfmIdDocker类将 Docker 映像用于 CFM-ID 而不是本地文件。

from cfm_id import CfmIdDocker

cfm_id = CfmIdDocker("myrepo/image_name:tag")

在 Docker 映像中,必须位于cfm-predictPATH 环境变量中,param_output.log 并且param_config.txt文件必须位于工作目录中。

您还可以使用环境变量CFMID_IMAGE而不是路径参数。

export CFMID_IMAGE=myrepo/image_name:tag
from cfm_id import CfmIdDocker

cfm_id = CfmIdDocker()

项目详情


下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

cfm_id-0.1.7.ta​​r.gz (5.4 kB 查看哈希

已上传 source

内置分布

cfm_id-0.1.7-py3-none-any.whl (6.0 kB 查看哈希

已上传 py3