MobileElementFinder 1.0.5

MobileElementFinder是一种用于在全基因组 Shotgun 序列数据中识别移动遗传元素 (MGE) 的工具。

它旨在预测组装的全基因组测序细菌 DNA 中的移动元件。通过将组装的连续序列与先前已知元素的参考序列对齐来预测 MGE。假定的复合转座子被标记。此命令行版本的 MobileElementFinder 旨在在您的本地机器上或在 docker 容器内运行。

注意：MobileElementFinder 也可在 https://cge.cbs.dtu.dk/services/MobileElementFinder/上作为在线软件服务使用

安装

克隆存储库。

确保安装了以下软件依赖项。如果没有将依赖项放入您的$PATH文件中，则必须将它们的位置提供给 MobileElementFinder。

• Ncbi blast v2.10.0 或更新版本
• KMA v1.2.3 或更新版本（可选）

根据您的操作系统，依赖项可能在其包管理器系统上可用。

对于macOS 上的Homebrew 。

$ brew install blast

要使用数据库安装 MobileElementFinder，只需从 pypi 安装它。

$ pip install MobileElementFinder

使用 MobileElementFinder

使用该命令$ mefinder find --help查看完整的选项列表。

MobileElementFinder 将组装的连续核苷酸序列作为输入。--contig使用标志指定序列文件。输出文件的路径和名称被指定为参数。

$ mefinder find --contig /path/to/genome.fna output_name

MobileElementFinder 在两个文件中报告预测的移动元素。预测的 MGE 及其质量指标被写入 CSV 文件，它们的核苷酸序列被写入 FASTA 文件。CSV 文件中的前五行包含注释，以 # 开头并包含有关如何生成文件的键值对元数据。根据下游电子表格应用程序或解析器，用户可能需要手动指定应省略这些行。

MobileElementFinder 还可以通过使用标志以GFF3 格式额外输出 MGE 在不同重叠群上的位置。--gff这允许使用基因组浏览器软件进行可视化。用户可以选择通过将用于组装样本的原始读数与 KMA 对齐来注释预测元素的序列深度。fastq 要启用此功能，请使用标志指定 fastq 格式的序列文件。

MobileElementFinder 的选项和配置

MobileElementFinder 的操作可以通过为程序提供可选标志或通过为程序提供个人配置文件来进行调制。

Usage: mobileElementFinder.py find [OPTIONS] OUTPUT

  Find mobile element in sequence data.

Options:
  -c, --contig PATH        Specify pre-assembled contigs to perform analysis
                           on.

  -f, --fq-file PATH       Sequencing files in fastq format. Only used for
                           annotating sequence depth in GFF files (Optional)

  --config FILE            Path to user defined config
  -j, --json               Write output in json format.
  -g, --gff                Write MGE location on contig in gff format.
  -t, --threads INTEGER    Number of threads [default: 1]
  --min-coverage FLOAT     Minimum coverage
  --max-evalue INTEGER     Maximum alignment e-value
  --temp-dir PATH          Set directory for temporary files.
  --kma-path TEXT          Path to KMA, if the executable is not in PATH
  --blastn-path TEXT       Path to Blast, if the executable is not in PATH
  --makeblastdb-path TEXT  Path to Blast, if the executable is not in PATH
  --db-path PATH           Path to MGEdb
  --help                   Show this message and exit.

• 线程:: 设置软件允许使用的处理器线程数

• min-coverage :: 设置爆炸 HSP 的最小总对齐覆盖率的阈值。有效范围 0 < x < 1。

• min-identity :: 设置模板和查询之间最小总序列同一性的阈值。有效范围 0 < x < 1。

• json :: 以机器可读的 json 格式写入扩展输出。

• makeblastdb-path :: 设置自定义路径进行爆炸。

• db-path :: MGEdb 的路径。这主要用于未将 Mobile Element Finder 安装为 python 包的情况。

  仅建议高级用户使用自定义配置文件。示例配置文件位于./example.config.ini. 要指定配置文件的路径，请使用标志--config。

更新 MobileElementFinder

MobileElementFinder 使用 pip 进行了更新。

pip install -e . --upgrade

在 docker 中运行 MobileElementFinder（可选）

您可以选择使用容器化版本的 MobileElementFinder。这通过确保正确安装软件依赖项来简化运行该工具的某些方面。

安装

MobileElementFinder 的预构建 docker 映像托管在 Dockerhub 上。您可以使用以下命令提取最新图像或特定版本。

# pull the latest build
$ docker pull mkhj/mobile_element_finder:latest

# pull version 1.0.0
$ docker pull mkhj/mobile_element_finder:1.0.0

使用 MobileElementFinder

要从 docker 容器外部运行 MobileElementFinder，请使用以下 make 命令。它将参数转发到容器化的 MobileElementFinder 工具。

$ make run CMD="mefinder find -t 4 -f ./data/forward_reads.fastq -f ./data/reverse_reads.fastq result"

文件夹volumes/data和volumes/finder链接为允许访问本地计算机文件系统的 docker 卷。将 fastq 和组装好的 contigs 放入volumes/data. MobileElementFinder 默认将临时文件写入链接到的临时文件夹，volumes/finder以便访问 docker 映像之外的临时文件。

该工具可以通过首先使用命令在容器内交互运行。

$ make bash

发展

在您选择的终端中运行以下命令以安装开发要求。

pip install -r requirements-devel.txt

要使用 tox 运行自动化集成测试，请使用以下命令。

tox py37 py36

lint 代码运行

tox lint