bamdst 项目使用教程

bamdst 项目使用教程

bamdst a lightweight bam file depth statistical tool 项目地址: https://gitcode.com/gh_mirrors/ba/bamdst

1. 项目目录结构及介绍

bamdst/
├── LICENSE
├── Makefile
├── README.md
├── bamdst.c
├── bedtk.c
├── bedutil.c
├── bedutil.h
├── bgzf.c
├── bgzf.h
├── commons.c
├── commons.h
├── count.h
├── khash.h
├── knetfile.c
├── knetfile.h
├── kseq.h
├── ksort.h
├── kstring.c
├── kstring.h
└── misc/
    ├── example/
    └── samlib/

目录结构说明

• LICENSE: 项目的许可证文件。
• Makefile: 项目的编译配置文件。
• README.md: 项目的介绍和使用说明。
• bamdst.c: 项目的主程序文件，负责处理BAM文件的深度统计。
• bedtk.c: 处理BED文件的工具文件。
• bedutil.c 和 bedutil.h: BED文件处理的相关工具和头文件。
• bgzf.c 和 bgzf.h: BGZF压缩文件处理的相关文件。
• commons.c 和 commons.h: 通用工具和头文件。
• count.h: 计数相关的头文件。
• khash.h: 哈希表相关的头文件。
• knetfile.c 和 knetfile.h: 网络文件处理的相关文件。
• kseq.h: 序列处理相关的头文件。
• ksort.h: 排序相关的头文件。
• kstring.c 和 kstring.h: 字符串处理的相关文件。
• misc/: 其他辅助文件和示例文件夹。

2. 项目启动文件介绍

项目的启动文件是 bamdst.c。该文件包含了主程序的入口点，负责解析命令行参数、调用相关函数进行BAM文件的深度统计，并生成相应的输出文件。

主要功能

• 命令行参数解析: 通过 getopt 函数解析用户输入的命令行参数。
• BAM文件处理: 调用相关函数读取和处理BAM文件。
• 输出文件生成: 根据处理结果生成覆盖率报告、累积分布图等输出文件。

3. 项目的配置文件介绍

项目没有显式的配置文件，但可以通过命令行参数进行配置。以下是一些常用的命令行参数：

• -p <probe.bed>: 指定探针或捕获目标区域的BED文件。
• -o <output_dir>: 指定输出目录。
• --maxdepth <num>: 设置最大深度值，用于过滤异常深度。
• --cutoffdepth <num>: 设置覆盖率报告中的指定深度值。
• --isize <num>: 设置合理的插入大小阈值。
• --uncover <num>: 设置覆盖率不足的区域阈值。

示例命令

bamdst -p probe.bed -o output_dir --maxdepth 1000 --cutoffdepth 10000 --isize 2000 --uncover 5

以上命令将使用 probe.bed 文件作为目标区域，输出结果到 output_dir 目录，并设置最大深度为1000，覆盖率报告中的指定深度为10000，插入大小阈值为2000，覆盖率不足的区域阈值为5。

bamdst a lightweight bam file depth statistical tool 项目地址: https://gitcode.com/gh_mirrors/ba/bamdst