# NextApp

**Repository Path**: xwhld/NextApp

## Basic Information

- **Project Name**: NextApp
- **Description**: No description available
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2019-07-11
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# NextApp

本程序为武汉未来组数据处理工具包，用于处理各类测序数据.

## Getting Started

该软件使用python3作为开发语言。

### Prerequisites
建议使用virtualenv创建的python的虚拟环境，并在虚拟环境中安装软件所需的python包。

```
source pyenv/bin/activate

pip install matplotlib
pip install numpy
pip install docxtpl
```
部分安装包依赖系统库环境，需要sudo权限安装

### Installing
本程序使用python setup 脚本按照并使用，python环境需求同上。

执行以下命令安装软件

```
cd NextApp
python setup.py install
```
得到如下信息则软件安装成功
```
nextapp 0.10 is already the active version in easy-install.pth
Installing nextapp.py script to pyenv/bin

Installed pyenv/lib/python3.5/site-packages/nextapp-0.10-py3.5.egg
```
### Usage
本程序有三种使用模式，分别用于Cell数据的质控和初级项目质控报告
#### 模式1：Analyze a Single ONT Cell
按单个cell进行fastq文件的过滤和数据统计
```
参数：-t cell
用法：nextapp ontqc -i /GBX_dir/20180620-NPL0135-K3 -t cell -qc 7 -ds 5000 -de 300000 -th 1
参数说明：
   -t: 运行模式
   -i: cell 文件夹全路径
   -th: 运行线程数, 默认值[1]
   -qc: qscore阈值, 默认值[7]
   -ds: read长度分布跨度, 默认值[5000]
   -de: read长度分布最大长度, 默认值[300000]
```
输出结果的目录默认为cell目录下GA*文件夹下新建的qc_report：
```
$ ls GBX_dir/20180620-NPL0135-K3/GA10000/qc_report
20180620-NPL0135-K3.fastq.gz
20180620-NPL0135-K3.sequencing_summary.txt.gz
20180620-NPL0135-K3.summary4stat.tsv.gz
qc_stat.json
qc_stat.tsv
tmp.filter.stat.json
```

#### 模式2：Analyze Multi ONT Cell
批量cell进行fastq文件的过滤和数据统计
```
参数：-t list
用法：nextapp ontqc -i /workdir/cell_list.txt -t cell -qc 7 -ds 5000 -de 300000 -th 1
参数说明：
   -t: 运行模式
   -i: 所需处理的多个cell 文件夹全路径列表文件
   其他：其他参数与-t cell 模式相同
```

#### 模式3：Data Collecting for Multiple ONT Cells
读取cell list文件中的所有cell目录统计数据，生成该测序样本的报告word文档。
```
参数：-t report
用法：nextapp ontqc -i /workdir/cell_list.txt -o /workdir/report_output/ -s NPLnx4 -p ONT项目 -wp 甘军 -vp 秦建虎
参数说明：
   -t: 运行模式
   -i: 报告多个cell 文件夹全路径列表文件，每个cell目录下必须存在-t cell或-t list的正确运行结果
   -o: 报告输出文件夹
   -p: 报告项目名称
   -s: 报告样本名称
   -wp: 报告撰写人，默认[甘军]
   -vp: 报告审核人，默认[秦建虎]
```

输出结果包括报告word文档和图片。
```
$ ls output/
data_volume.png
20180419-nx9-K4.interval_distribution_of_read_length_percent.png
20180419-nx10-K5.interval_distribution_of_read_length_percent.png
20180424-NPLnx4-K1.cumulative_distribution_of_read_length_percent.png
test.ONT_Data_Report.docx
```
## Deployment

Add additional notes about how to deploy this on a live system

## Authors

* **Ying Zhu** - *Initial work* - [NextApp](https://gitee.com/zhuying/NextApp)

See also the list of [contributors](https://gitee.com/zhuying/NextApp/contributors) who participated in this project.

## License

NextOmics Copyright(c) 2018.

## Acknowledgments

* Hat tip to anyone whose code was used
* Inspiration
* etc