.. raw:: html

<p align="center">
<img alt="DNA Features Viewer 标志" title="DNA Features Viewer 标志" src="https://yellow-cdn.veclightyear.com/835a84d5/a20ca9dc-9878-43ab-bd32-c5f2980cb594.png" width="350">
</p>

DNA 特征查看器

.. image:: https://github.com/Edinburgh-Genome-Foundry/DnaFeaturesViewer/actions/workflows/build.yml/badge.svg :target: https://github.com/Edinburgh-Genome-Foundry/DnaFeaturesViewer/actions/workflows/build.yml :alt: GitHub CI 构建状态

.. image:: https://coveralls.io/repos/github/Edinburgh-Genome-Foundry/DnaFeaturesViewer/badge.svg?branch=master :target: https://coveralls.io/github/Edinburgh-Genome-Foundry/DnaFeaturesViewer?branch=master

DNA Features Viewer（完整文档在 这里 <https://edinburgh-genome-foundry.github.io/DnaFeaturesViewer/>_）是一个用于可视化 DNA 特征的 Python 库，例如来自 GenBank 或 GFF 文件，或 Biopython SeqRecords：

.. raw:: html

<p align="center">
<img src="https://yellow-cdn.veclightyear.com/835a84d5/d94861c7-b5ed-4c40-82ad-d62c15ee7185.png" width="500">
</p>

DNA Features Viewer 能够自动生成简洁清晰的图像，即使是对于具有许多重叠特征和长标签的序列。该库与 Matplotlib 和 Biopython 配合良好，可以输出多种不同格式的图像（PNG、JPEG、SVG、PDF），例如用于报告生成、文章图表或 LIMS 界面。

安装

如果您已安装 PIP，只需在终端中输入：

.. code:: bash

pip install dna_features_viewer

DNA Features Viewer 也可以通过解压源代码到一个目录中，然后使用以下命令安装：

.. code:: bash

python setup.py install

如果您打算使用 bokeh 功能，还需要安装 Bokeh 和 Pandas：

.. code:: bash

pip install bokeh pandas

要解析 GFF 文件，请安装 bcbio-gff 库：

.. code:: bash

pip install bcbio-gff

使用示例

基本绘图

在这个第一个示例中，我们"手动"定义特征：

.. code:: python

    from dna_features_viewer import GraphicFeature, GraphicRecord
    features=[
        GraphicFeature(start=0, end=20, strand=+1, color="#ffd700",
                       label="小特征"),
        GraphicFeature(start=20, end=500, strand=+1, color="#ffcccc",
                       label="基因1，名称很长"),
        GraphicFeature(start=400, end=700, strand=-1, color="#cffccc",
                       label="基因2"),
        GraphicFeature(start=600, end=900, strand=+1, color="#ccccff",
                       label="基因3")
    ]
    record = GraphicRecord(sequence_length=1000, features=features)
    record.plot(figure_width=5)

.. raw:: html

    <p align="center">
    <img src="https://yellow-cdn.veclightyear.com/835a84d5/d94861c7-b5ed-4c40-82ad-d62c15ee7185.png" width="500">
    </p>


如果我们在上面的代码中将 `GraphicRecord` 替换为 `CircularGraphicRecord`，我们就可以得到构造的环形图：

.. raw:: html

    <p align="center">
    <img src="https://yellow-cdn.veclightyear.com/835a84d5/8923fb28-e654-48e0-a0f4-e324904309da.png" width="443">
    </p>

也可以通过使用 ``plot_with_bokeh`` 而不是 ``plot`` 来生成交互式（基于浏览器）的图表：

.. raw:: html

    <p align="center">
    <img src="https://yellow-cdn.veclightyear.com/835a84d5/a0d4a08b-aa98-4822-8c53-d8ffc639fa57.png" width="800">
    </p>

核苷酸序列、翻译和裁剪

DNA Features Viewer 允许在记录图下方绘制核苷酸或氨基酸序列：

.. code:: python

from dna_features_viewer import GraphicFeature, GraphicRecord

sequence = "ATGCATGCATGCATGCATGCATGCATGC"
record = GraphicRecord(sequence=sequence, features=[
    GraphicFeature(start=5, end=10, strand=+1, color='#ffcccc'),
    GraphicFeature(start=8, end=15, strand=+1, color='#ccccff')
])

ax, _ = record.plot(figure_width=5)
record.plot_sequence(ax)
record.plot_translation(ax, (8, 23), fontdict={'weight': 'bold'})
ax.figure.savefig('sequence_and_translation.png', bbox_inches='tight')

.. raw:: html

<p align="center">
<img src="https://yellow-cdn.veclightyear.com/835a84d5/7f83d279-e69f-4a10-926c-a9f1b9f20669.png" width="415">
</p>

这使得可以绘制序列的概览以及序列子段的详细视图（完整代码 <https://github.com/Edinburgh-Genome-Foundry/DnaFeaturesViewer/blob/master/examples/overview_and_detail.py>_）

.. code:: python

...
record.plot(ax=ax1)
cropped_record = record.crop((zoom_start, zoom_end))
cropped_record.plot(ax=ax2)
cropped_record.plot_sequence(ax=ax2)
cropped_record.plot_translation(ax=ax2, location=(408, 423))

.. raw:: html

<p align="center">
<img src="https://yellow-cdn.veclightyear.com/835a84d5/13458ba2-8c74-4429-ae61-2bffa929783f.png" width="900">
</p>

从 GenBank 或 GFF 文件读取特征

DnaFeaturesViewer 与 BioPython 配合良好。因此，绘制 Biopython 记录的内容，或直接绘制 GenBank（或 GFF）文件非常简单：

.. code:: python

    from dna_features_viewer import BiopythonTranslator
    graphic_record = BiopythonTranslator().translate_record("my_sequence.gb")
    ax, _ = graphic_record.plot(figure_width=10, strand_in_label_threshold=7)

.. raw:: html

    <p align="center">
    <img src="https://yellow-cdn.veclightyear.com/835a84d5/c8bd53ba-051d-44e7-81d1-2838dc4967f6.png" width="900">
    </p>

注1：脚本使用 ``strand_in_label_threshold=7`` 来在注释文本中为每个宽度小于约7像素的特征用箭头指示链方向。

注2：``BiopythonTranslator`` 类决定了如何将 genbank 信息转换为图形特征。它允许选择要绘制的特征类别以及不同特征的颜色。

注3：解析 GFF 文件需要 BCBio 库（``pip install bcbio-gff``）。这个库还能够从包含多个记录的 GFF 文件中提取 Biopython 记录（使用 ``GFF.parse("records.gff")``）。

与其他图表一起显示特征
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

由于它使用 Matplotlib，DNA Features Viewer 可以将特征与其他序列统计信息一起显示，例如局部 GC 含量：

.. code:: python

    import matplotlib.pyplot as plt
    from dna_features_viewer import BiopythonTranslator
    from Bio import SeqIO
    import numpy as np

    fig, (ax1, ax2) = plt.subplots(
        2, 1, figsize=(12, 3), sharex=True, gridspec_kw={"height_ratios": [4, 1]}
    )

    # 绘制记录图
    record = SeqIO.read("example_sequence.gb", "genbank")
    graphic_record = BiopythonTranslator().translate_record(record)
    graphic_record.plot(ax=ax1, with_ruler=False, strand_in_label_threshold=4)
# 绘制局部GC含量(我们使用50bp窗口)
    gc = lambda s: 100.0 * len([c for c in s if c in "GC"]) / 50
    xx = np.arange(len(record.seq) - 50)
    yy = [gc(record.seq[x : x + 50]) for x in xx]
    ax2.fill_between(xx + 25, yy, alpha=0.3)
    ax2.set_ylim(bottom=0)
    ax2.set_ylabel("GC(%)")

多行和多页图表
~~~~~~~~~~~~~~~

从v3.0版本开始,可以在多行(使用``record.plot_on_multiple_lines()``)甚至多页(PDF)上绘制序列:

.. code:: python

    graphic_record.plot_on_multiple_pages(
        "multipage_plot.pdf",
        nucl_per_line=70,
        lines_per_page=7,
        plot_sequence=True
    )

自定义Biopython转换器
----------------------------

DNA Features Viewer允许通过使用自定义记录转换器而不是默认的``BiopythonTranslator``来定义"主题"。以下是一个示例:

.. code:: python

    from dna_features_viewer import BiopythonTranslator

    class MyCustomTranslator(BiopythonTranslator):
        """自定义转换器实现以下主题:

        - 将终止子着色为绿色,CDS为蓝色,所有其他特征为金色。
        - 不显示限制性位点特征,除非是BamHI
        - 不显示限制性位点的标签
        - 对于CDS标签,只写"CDS here"而不是基因名称。

        """

        def compute_feature_color(self, feature):
            if feature.type == "CDS":
                return "blue"
            elif feature.type == "terminator":
                return "green"
            else:
                return "gold"

        def compute_feature_label(self, feature):
            if feature.type == 'restriction_site':
                return None
            elif feature.type == "CDS":
                return "CDS here"
            else:
                return BiopythonTranslator.compute_feature_label(self, feature)

        def compute_filtered_features(self, features):
            """不显示启动子。仅仅是因为。"""
            return [
                feature for feature in features
                if (feature.type != "restriction_site")
                or ("BamHI" in str(feature.qualifiers.get("label", '')))
            ]


    graphic_record = MyCustomTranslator().translate_record("example_sequence.gb")
    ax, _ = graphic_record.plot(figure_width=10)
    ax.figure.tight_layout()
    ax.figure.savefig("custom_bopython_translator.png")

其他包中的示例:
---------------------------

DNA Chisel
~~~~~~~~~~~

这个GIF使用DNA Features Viewer来绘制使用`DNA Chisel <https://github.com/Edinburgh-Genome-Foundry/DnaChisel>`_优化DNA序列的进度。它还使用`Proglog <https://github.com/Edinburgh-Genome-Foundry/Proglog>`_在不同时间点自动生成图片。这个示例不太好的Python代码可以在`Gist <https://gist.github.com/Zulko/f9aa781aaaab2c4d66ccd968ca85ca1d>`_上找到。

GeneBlocks
~~~~~~~~~~
`GeneBlocks <https://github.com/Edinburgh-Genome-Foundry/Geneblocks>`_是一个Python库,用于计算两个序列构建的"差异",指示所有的变化(添加、删除、突变)。它使用DNA Features Viewer来显示这些变化以及其他序列的特征。

许可证 = MIT
-------------

DNA Features Viewer是一个开源软件,最初由`Zulko <https://github.com/Zulko>`_在`爱丁堡基因组铸造厂<http://genomefoundry.org>`_编写,并在MIT许可下`在Github上发布<https://github.com/Edinburgh-Genome-Foundry/DnaFeaturesViewer>`_。欢迎每个人做出贡献!

更多生物学软件
---------------------

DNA Features Viewer是`EGF Codons <https://edinburgh-genome-foundry.github.io/>`_合成生物学软件套件的一部分,用于DNA设计、制造和验证。