wes-germline-hg19/README.md

> Author : Jingcheng Yang & Yechao Huang
>
>
> E-mail：[1721070009@fudan.edu.cn](mailto:1721070009@fudan.edu.cn)
>
> Git: <http://choppy.3steps.cn/huangyechao/wes-germline.git>
>
> Last Updates: 06/02/2019

## 简介

`wes-germline`是根据 [Sentieon](https://support.sentieon.com/manual/) 软件全外显子组`Germline`突变数据分析推荐流程所构建的 [Choppy-pipe](http://choppy.3steps.cn/) 系统的 APP。利用该 APP 可以获得从全外显子组测序原始文件`fastq` 到包含`Germline`突变信息的`vcf`文件的整个过程。主要包括数据的预处理、中间数据质控以及变异的检测。

## 快速安装

#### Requirements

- Python 3
- [choppy](http://choppy.3steps.cn/)
- Ali-Cloud

在终端中输入以下命令即可快速安装本APP。

```bash
$ source activate choppy
$ choppy install huangyechao/wes-germline-latest
$ choppy apps
```

## 使用方法

### 任务准备

按照上述步骤安装成功之后，可以通过下面简单的命令即可使用APP：

```bash
# Generate samples file
$ choppy samples huangyechao/wes-germline-latest --out samples.csv
```

`sample.csv` 包含以下几个需要填写的参数：

``` bash
read1,read2,sample_name,cluster,sample_id,disk_size,regions
# read1  		双端测序数据的R1端在阿里云上的路径信息
# read2  		双端测序数据的R2端在阿里云上的路径信息
# sample_name	输出文件名的前缀
# regions		全外显子组测序时测序区域的bed文件
# cluster		使用的机器类型，不填则默认使用 OnDemand ecs.sn1ne.4xlarge img-ubuntu-vpc
# sample_id		每个样本任务的识别码。注意：同一个samples文件中，不同样本的ID应该不同
# disk_size		任务运行时，集群存储空间设置
```

> 机器类型选择可以参照：[计算网络增强型实例规格族sn1ne](https://help.aliyun.com/document_detail/25378.html?spm=a2c4g.11186623.2.11.1a3d6b46rNmksN#sn1ne) 以及 [bcs](https://help.aliyun.com/document_detail/42391.html?spm=5176.10695662.1996646101.searchclickresult.5c0b12b5Adk9Xc) 类型机器，对于全外显子组数据不要使用小于32CPU的机器类型

### 任务提交

在配置好`samples.csv` 文件后，使用以下命令可以提交计算任务：

```bash
$ choppy batch huangyechao/wes-germline-latest sample.csv --project-name Your_project_name
```

提交成功后，即可在工作目录下找到生成的目录名为Your_project_name，里面包含了本次提交任务的所有样本信息。

### 任务输出

任务成功结束后，便可以在阿里云相应的OSS端生成相应的结果文件。包括数据预处理产生的中间结果文件以及变异检测得到的`vcf`文件。

## 流程示意图

![](assets/wes.png)



### 输出文件说明

整个分析流程中，每个步骤输出的结果说明如下：

- **call-mapping** 原始数据经过比对后生成的排序后的`sample.sorted.bam`文件及其索引文件
- **call-Metrics** 比对后生成的`sample.sorted.bam`文件的质控信息
- **call-Dedup** 比对的结果去除重复后的`sample.sorted.deduped.bam`文件及其索引文件
- **call-deduped_Metrics** 去除重复后的`sample.sorted.deduped.bam` 文件的质控信息
- **call-Realigner** 去除重复后重比对的`sample.sorted.deduped.realigned.bam`文件及其索引文件
- **call-BQSR** 局部碱基矫正的`sample.sorted.deduped.realigned.recaled.bam`文件、索引文件及其相关信息
- **call-Haplotyper** 变异检测得到的`sample.vcf`文件及其索引文件

### 软件版本及参数

| 软件/文件           | 版本                                          |
| :------------------ | --------------------------------------------- |
| Sentieon            | v2018.08.01                                   |
| 参考基因组（fasta） | GRCh38.d1.vd1.fa                              |
| dbsnp               | dbsnp_146.hg38.vcf                            |
| db_mills            | Mills_and_1000G_gold_standard.indels.hg38.vcf |



### 附录



### 参考文献