downsample/README.md

### APP简介

本app用于从FASTQ文件中随机抽取N条read，生成down-sample后的FASTQ文件。

app仅接受以***.fastq.gz***或***.fq.gz***为结尾的文件，输出文件为GZIP压缩后的FASTQ文件（后缀名为.fastq.gz）

> 注意：
>
> 本app使用***seqkit sample***进行downsample，根据官方文件说明，downsample后的FASTQ文件的read数不一定严格等于down_to的目标。如：down_to=1000 时，可能最终获得的fastq中仅有991条read。
>
> 对此不能接受者，请不要使用本app。



### 安装指南

```
# 激活choppy环境
source activate choppy-pipe-0.3.8.dev0

# 安装 app
choppy install chenziyin/downsample
```





### 快速使用


##### 准备样本描述文件：samples.csv

需要包括3列：

   - sample_id：每个样本唯一的ID
   - fastq：原始fastq地址
   - down_to：downsample后目标read数

样表如下：  

| sample_id | fastq | down_to |
| -------- | -------- | -------- |
| test     | oss://choppy-app-example-data/miRNAseq/test_10k_NEXTflex.fastq.gz     | 1000     |



   

##### 批量提交任务

```bash
choppy batch chenziyin/downsample-latest <SAMPLES_CSV> --project-name <PROJECT_NAME> 
```



### 使用的软件及版本：

- Seqkit: 0.12.0