LUMPY 使用与技术文档

本文档旨在帮助用户了解和安装LUMPY软件包，并详细介绍其使用方法和API文档，以便更好地利用这一概率框架进行结构变异检测。

1. 安装指南

环境要求

LUMPY安装需要以下环境和依赖：

• g++编译器
• CMake
• （可选）LUMPY Express需要Samtools (0.1.18+)、SAMBLASTER (0.1.19+)、Python 2.7以及相关库

安装步骤

1. 克隆项目仓库：

   git clone --recursive https://github.com/arq5x/lumpy-sv.git
   

2. 进入项目目录并编译：

   cd lumpy-sv
   make
   

3. 将编译后的bin目录下的文件复制到系统路径下：

   cp bin/* /usr/local/bin/.
   

如遇到安装自定义zlib的问题，可以设置环境变量ZLIB_PATH并重新编译。

2. 项目使用说明

快速开始

如果您想快速开始使用LUMPY，可以按照以下步骤操作：

1. 下载并安装LUMPY：

   git clone --recursive https://github.com/arq5x/lumpy-sv.git
   cd lumpy-sv
   make
   cp bin/* /usr/local/bin/.
   

2. 运行LUMPY Express：

   lumpyexpress \
       -B my.bam \
       -S my.splitters.bam \
       -D my.discordants.bam \
       -o output.vcf
   

3. 项目API使用文档

LUMPY提供了两种使用方式：LUMPY Express和传统的LUMPY。以下是两种方式的基本使用说明：

LUMPY Express

LUMPY Express为标准分析提供了自动化的断点检测。

基本用法：

lumpyexpress [options]

必须参数：

-B FILE  坐标排序的BAM文件
-S FILE  分割 reads 的BAM文件
-D FILE  离群 reads 的BAM文件

可选参数：

-o STR    输出文件名
-x FILE   排除的BED文件
-P        为每个变异输出概率曲线
-m INT    最小样本权重
-r FLOAT  裁剪阈值
-T DIR    临时文件目录
-k        保留临时文件
-K FILE   lumpyexpress配置文件路径
-v        详细模式
-h        显示帮助信息

传统LUMPY

传统的LUMPY提供了灵活且可定制的断点检测。

基本用法：

lumpy [options]

选项：

-g       基因组文件（定义染色体顺序）
-e       显示每个调用的证据
-w       文件读取窗口大小
-mw      所有样本的最小权重
-msw     每个样本的最小权重
-tt      裁剪阈值
-x       排除文件（bed文件）
-t       临时文件前缀
-P       为每个变异输出概率曲线
-b       输出为BEDPE格式而非VCF

更多高级用法和选项，请参考项目文档。

4. 项目安装方式

本文档已在上文详细说明了LUMPY的安装方式，包括所需环境、安装步骤以及可能的定制安装选项。按照上述步骤操作，即可完成LUMPY的安装。