Skip to main content

FastANI 程序的包装器。

项目描述

快速ANI

派皮

该软件包的开发目的是为 FastANI工具提供 Python 接口。

安装

注意:您必须自己安装 FastANI 二进制文件才能使该软件包正常工作。

此包仅具有标准依赖项,适用于 Python 版本 >=3.6。

pip install fastani

基本用法

注意:除矩阵和可视化方法外的所有功能均已实现。

要使用此包,只需调用该fastani方法,除 query和参数外的所有参数reference都是可选的,在这种情况下使用 FastANI 默认值。

queryandreference参数可以是字符串,也可以是指向 fasta 文件的字符串集合。

from fastani import fastani

result = fastani(query='query.fna', reference='reference.fna')
dict_results = result.as_dict()

# Accessing results
print(dict_results['query.fna']['reference.fna'].ani)         # 89.1234
print(dict_results['query.fna']['reference.fna'].n_frag)      # 50
print(dict_results['query.fna']['reference.fna'].total_frag)  # 100
print(dict_results['query.fna']['reference.fna'].align_frac)  # 0.5

# Writing results to disk
result.to_file('results.txt')

可以通过传递以下参数来覆盖 FastANI 默认参数:

  • exe:FastANI 二进制文件的路径。
  • k: 要使用的 kmer 大小。
  • cpus: 要使用的 CPU 数量。
  • frag_len:要使用的片段长度。
  • min_frac:共享基因组的最小比例。
  • min_frag:对齐片段的最小数量(version < 1.3)。

高级用法

有两个额外的参数可以提供给该fastani方法:

  • single_execution:如果设置为True(默认),FastANI 将使用查询和参考列表参数。如果设置为False,则将单独分析每个基因组。
  • bidirectional:如果设置为False(默认),FastANI 将只执行query -> reference比较。如果设置为True,则reference -> query还将执行比较。

项目详情


下载文件

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

源分布

fastani-1.1.0.tar.gz (20.0 kB 查看哈希)

已上传 source

内置分布

fastani-1.1.0-py3-none-any.whl (23.4 kB 查看哈希)

已上传 py3