#plot #bam #vega-lite #alignments #html #generated #format-json

app alignoth

从bam文件创建对齐图的工具

24个不稳定版本 (10个破坏性版本)

0.12.1 2024年7月1日
0.12.0 2024年3月5日
0.11.0 2023年11月15日
0.8.2 2023年5月10日
0.3.0 2022年7月25日

#21 in 生物学

MIT 许可证

445KB
1.5K SLoC

GitHub Workflow Status codecov Bioconda downloads Bioconda version install with bioconda Licence

alignoth

从bam文件创建对齐图的工具。默认情况下,生成的 vega-lite 图表将写入标准输出。一个生成的图表示例可以在这里看到 这里。alignoth 名称源自可视化的 对齐 和星号 alioth (使用vega图表)。

用法

alignoth-b 路径//我的.bam-r 路径//我的/参考.fa-g chr1:200-300 >plot.vl.json

要直接生成svg、png或pdf格式的图表,我们建议使用 vega-clivega-lite-cli 软件包

alignoth-b 路径//我的.bam-r 路径//我的/参考.fa-g chr1:200-300 |vl2vg|vg2pdf>plot.pdf

要在html文件中生成交互式视图,请使用 --html 并将输出捕获到文件中

alignoth -b path/to/my.bam -r path/to/my/reference.fa -g chr1:200-300 --html > plot.html

参数

使用alignoth时,以下选项可用

参数 简称 说明 默认值
bam路径 -b 要可视化的bam文件。
参考 -r 参考fasta文件的路径
区域 -g 可视化用的染色体和区域。例如:2:132424-132924
附近 -a 定义要绘制的区域的染色体和基位置。例如:2:17348
突出显示 -h 要突出显示的可视化中的区间或单个基位置。例如:132400-132500或132440
plot-all -p 在指定区域绘制所有读取序列。我们建议仅对此命令用于小型的 bam 文件和单个目标。 false
最大读取深度 -d 设置显示在比对图中的最大行数 500
最大宽度 -w 设置结果比对图的最大宽度 1024
输出 -o 如果存在,生成的图的数据和 vega-lite 规范将被分割并写入指定的目录
数据格式 -f 设置读取、参考和高亮数据的输出格式 json
辅助标签 -x 在图例的提示中显示给定的辅助标签内容。可以多次使用以显示多个标签。
规范输出 如果存在,vega-lite 规范将被写入给定的文件路径
读取数据输出 如果存在,读取数据将被写入给定的文件路径
参考数据输出 如果存在,参考数据将被写入给定的文件路径
高亮数据输出 如果存在,高亮数据将被写入给定的文件路径
HTML 如果存在,生成的图将被插入到包含图的简单 HTML 文件中,然后写入标准输出

安装

安装 alignoth 有多种方式

bioconda

Rust-Bio-Tools 可通过 Bioconda 获取。使用 Bioconda 设置后,安装就像这样

conda install alignoth

Cargo

如果已安装 Rust 编译器和相关的 Cargo,则可以通过以下方式安装 alignoth

cargo install alignoth

源代码

下载源代码,然后在源代码根目录下运行

cargo install

作者

依赖

~33–49MB
~814K SLoC