cnv/README.md

**Author：** Zhang Jiyang

**E-mail：**1611070062@fudan.edu.cn

**Git:** http://choppy.3steps.cn/jiyangz/cnv

**Last Updates:** 23/1/2019

**Description**

> 本 APP 所构建的是用于二代测序拷贝数变异分析。使用的软件是[cn.mops](http://goldenhelix.com/products/sentieon/index.html)：*Mixture of Poissons for CNV detection in NGS data* 。本流程构建所使用的方法是基于流程语言WDL 并将其封装为[Choppy](http://docs.3steps.cn)平台上的APP进行使用。输入文件如下：

1. Tumor：通常为**Tumor**样本的**bam**文件；

2. Normal：通常为**Normal**样本的**bam**文件；

3. TumorSampleID：通常为**Tumor**样本的**ID**；

4. bed_file： 通常为bed文件 (tab分割)，示例格式如下图：

   ![BED](C:\Users\jiyang\Desktop\CNV_App\assets\BED.jpg)

5. workDir：通常为**bam**文件存放目录；

6. outputDir：通常为结果输出目录。



## App使用指南
### 安装App

```bash
# 激活choppy环境
source activate choppy-latest
# 安装app
choppy install jiyangz/cnv:<version>
```

### 准备samples文件
`sample.csv` 文件为提交任务时使用的输入文件，其内容是根据`input`文件中定义的信息对应生成的，也可使用 `Choppy` 的 `samples` 功能生成:
```bash
choppy samples cnv --output samples.csv
```

```bash
#### samples.csv
read1,read2,regions,sample_name,cluster,disk_size,sample_id
```
其中`sample_id`对应于所分析样本的索引号，用于生成当前样本提交时的任务信息，应注意不要包含`_`,否则会出现报错。

### 提交任务
```bash
choppy batch cnv samples.csv --project-name your_project
```

## 更多使用信息
详见[Choppy使用说明](http://docs.3steps.cn))