mtbconverter 0.1.3

mtbconverter
==============

|语言| |特拉维斯| |编解码器| |gh标签| |pypi| |许可证|

一个 Python 命令行工具，用于解析和转换 UKT Tübingen 的分子肿瘤委员会的诊断变异数据。

.. |语言| 图片:: https://img.shields.io/github/languages/top/qbicsoftware/qbic.mtbconverter.svg

.. |travis| 图片:: https://travis-ci.org/qbicsoftware/qbic.mtbconverter.svg?branch=master
:目标: https://travis-ci.org/qbicsoftware/qbic.mtbconverter
.. |codecov| 图片：：https
://codecov.io/gh/qbicsoftware/qbic.mtbconverter/branch/master/graph/badge.svg：目标：https://codecov.io/gh/qbicsoftware/qbic.mtbconverter
.. |ghtag| 图片:: https://img.shields.io/github/release/qbicsoftware/qbic.mtbconverter/all.svg
:目标: https://github.com/qbicsoftware/qbic.mtbconverter/releases
.. |pypi| 图片:: https://img.shields.io/pypi/v/mtbconverter.svg
:目标: https://pypi.python.org/pypi/mtbconverter
.. |license| image:: https://img.shields.io/github/license/qbicsoftware/qbic.mtbconverter.svg


.. contents:: 目录
：depth: 2


Commands
---------

如果你提供``-h`` 参数，你会得到命令概述：

.. code-block:: bash

Mtbconverter version 0.1
用法： mtbconverter.py [-h] [command]

命令：
convert 将变体信息转换为 CentraXX XML。
push 将一个或多个 XML 文件推送到 CentraXX。
目录 构建 CentraXX 目录 XML 文件。

mtbconverter 目前支持三个命令：``convert、push`` 和 ``catalogue``。

convert
~~~~~~~
``convert`` 命令告诉 mtbconverter 从给定的 zip 存档中解析必要的 MTB 信息。存档需要包含多个 TSV 文件。它遵循 mtbparser 模块中描述的格式规范和命名约定，该模块在 mtbconverter 中实现。

.. _specification: https://github.com/qbicsoftware/qbic.mtbparser/blob/master/README.md

.. 代码块:: bash

Mtbconverter 0.1 版。
用法：convert [-h] archive patientID

将变体信息转换为符合 XML 的 CentraXX 模式。

位置参数：
包含变体信息文件的存档 ZIP 存档。
patientID QBiC 患者 ID。

可选参数：
-h，--help 显示此帮助消息并退出

输出是根据 CetraXX DataExchange 规范的 XML，它反映了从 MTB ZIP 存档中解析的信息，并且可以导入到 CentraXX，例如使用 `` mtbconverter 推送命令。

**存档格式规范**
ZIP 档案名称需要带有 QBIC 条形码，并且同样需要出现在档案内的所有文件中。这只是为了确保文件确实属于同一个样本。

.. code-block:: bash

存档名称：
<QBIC-barcode>_*.zip

存档内容：
<QBiC-Barcode>_somatic_snv.tsv
<QBiC-Barcode>_somatic_cnv.tsv
<QBiC-Barcode>_germline_snv.tsv
<QBiC- Barcode>_germline_cnv.tsv
<QBiC-Barcode>_somatic_sv.tsv
<QBiC-Barcode>_metadata.tsv

信息被编码在六个 TSV 文件中，遵循 ``mtbparser`` library_ 中详细描述的规范。

推
~~~~
``push`` 命令可以通过 CentraXX 的 REST API 将 CentraXX 患者 XML 导入 CentraXX 系统。使用 ``-h`` 标志，您可以获得参数的概览：

.. code-block:: bash

Mtbconverter version 0.1。
用法： push [-h] [-c config] [-t] [--check]

patientdata 将转换后的 XML 文件导入 CentraXX。

位置参数：
patientdata 从 MTB ZIP 存档转换的 XML 文件，其中包含变体
信息。

可选参数：
-h、--help 显示此帮助消息并退出-c config 带有远程 CentraXX 系统
设置的配置文件。
（默认：/etc/centraxx.config）
-t, --test 导入到 CentraXX 测试系统。
--check 检查与 CentraXX 的连接。

``mtbconverter`` 默认会尝试解析``/etc/centraxx.config`` 中的配置文件，但你也可以通过``-c`` 选项指定另一个路径。

**CentraXX 配置文件**
配置文件包含有关 CentraXX 的服务器位置和身份验证数据的信息。示例配置文件应如下所示：

.. code-block:: bash

[CENTRAXX_TEST]
authuser=myuser
password=mypassword
serveraddr=127.0.0.1:443
protocol=https
infopath=%(protocol)s://%(serveraddr )s/centraxx/rest/info

[CENTRAXX]
authuser=myuser
password=mypassword
serveraddr=xxx.x.xxx.xxx:xxxx
protocol=https
infopath=%(protocol)s://%(serveraddr)s/centraxx/rest/info

``[...]`` 部分是配置的部分。``mtbconverter`` 当前支持“CENTRAXX”和“CENTRAXX_TEST”。如果您指定“CENTRAXX_TEST”部分，那么您可以使用 -t 选项标志对目标测试系统执行操作。

如果您提供带有有效路径的 ``infopath`` 关键字，则可以通过提供 ``--check`` 选项标志轻松检查到 CentraXX 的连接。如果无法访问目标服务器，您将收到超时响应，或者您将看到带有消息的返回代码。

目录
~~~~~~~~~
``catalogue`` 命令为 CentraXX 控制的词汇、参数定义和配置文件创建 XML 文件。每次规范更改时只需执行一次，因此 CentraXX 知道如何连接传入的数据，一旦它被导入。

执行 ``catalogue`` 后，mtbconverter 将创建 8 个 XML 文件：

1. cv_centraxx.xml：CentraXX 的受控词汇。
2. params_centraxx.xml：CentraXX 的参数和预期数据类型。
3. ssnv_profiles_centraxx.xml：体细胞 SNV 的配置文件。
4. scnv_profiles_centraxx.xml：体细胞 CNV 的配置文件。
5. gsnv_profiles_centraxx.xml：种系 SNV 的配置文件。
6. gcnv_profiles_centraxx.xml：种系 CNV 的配置文件。
7. sv_profiles_centraxx.xml：体细胞结构变异的配置文件。
8. metadata_profiles_centraxx.xml：元数据配置文件，包含诊断。


Changelog
---------
在这里找到``mtbconverter`` 的所有版本变化 2018-02-07

: v0.1.1
~~~~~~~~~
小bug修复，添加入口点，所以mtbconverter可用作命令行工具

2018-02-06: v0.1
~~~~~~~~~
第一个正式版本，尚未支持所有需要的CentraXX推送选项，但即将推出！

作者
------
此代码由蒂宾根大学 QBiC 的 Sven Fillinger 提供。


.. _library：https://github.com/qbicsoftware/qbic.mtbparser/blob/master/README.md