# rnaseq4km

**Repository Path**: battlerabbit/rnaseq4km

## Basic Information

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

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-04-25
- **Last Updated**: 2024-08-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# RNA4KM

## 背景描述

## 技术栈

容器技术：apptainer (>=1.2.5)

调度引擎：nextflow (>=24.04)

## 安装部署

流程无需安装，从gitee克隆下来即可使用 `git clone https://gitee.com/battlerabbit/rnaseq4km.git`

## 使用前准备

### 准备镜像

此流程所需的镜像较多：

* 基础镜像(base)：/bioinfo/data/user010/cuity_dev/images/base_image/base.sif
* python与R镜像(python_r_image)：/bioinfo/data/user010/cuity_dev/images/python_r_image/python_r_image.sif
* eggnog注释软件镜像(eggnog_mapper)：/bioinfo/data/user010/cuity_dev/images/eggnog_mapper/eggnog_mapper.sif
* circos与perl镜像(circos_perl)：/bioinfo/data/user010/cuity_dev/images/circos_image/circos_perl.sif

除取镜像之外，还需要秘钥才能启动镜像，秘钥路径：`/bioinfo/data/user010/cuity_dev/images/base_image/id_rsa_pri.pem`

### 软件和依赖包

* 安装 [apptainer](https://apptainer.org/docs/user/latest/quick_start.html#installation)（user010@43.138.80.104已经完成安装）
* 安装 [nextflow](https://www.nextflow.io/docs/latest/install.html)（user010@43.138.80.104已经完成安装）

除了上述两个软件之外，无需安装其他软件，拷贝如下路径即可：`/bioinfo/data/user010/cuity_dev/software`

***注意：部分软件、python包、R包和perl包无法直接使用，必须在镜像下才能使用，如需在流程外使用，请查阅Apptainer使用手册***

### 全局配置文件和项目配置文件

全局配置文件：*nextflow.config*

项目配置文件：*parameter.json, samplesheet.xlsx*

#### nextflow.config

* 用于配置apptainer容器挂载额外的路径
* 配置各模块的运行镜像
* 配置镜像的秘钥路径

若无特殊情况，请不要删除或修改已有配置，若新增模块，请参考已有配置。

#### samplesheet.xlsx

记录样本信息和分组，模板如下：

| #sample_info |                                                                   |                                                                   |                 |       |         |         |            |
| ------------ | ----------------------------------------------------------------- | ----------------------------------------------------------------- | --------------- | ----- | ------- | ------- | ---------- |
| sample_name  | fastq1                                                            | fastq2                                                            | project         | group | species | comment | date       |
| SRR6798476   | /bioinfo/data/user010/cuity_dev/data/RNASeq/SRR6798476_1.fastq.gz | /bioinfo/data/user010/cuity_dev/data/RNASeq/SRR6798476_2.fastq.gz | rnaseq_analysis | IHC   | mouse   |         | 2024-02-28 |
| ...          | ...                                                               | ...                                                               | ...             | ...   | ...     | ...     | ...        |
| #group_info  |                                                                   |                                                                   |                 |       |         |         |            |
| group_A      | group_B                                                           | project                                                           |                 |       |         |         |            |
| IHC          | OHC                                                               | rnaseq_analysis                                                   |                 |       |         |         |            |
| #step        |                                                                   |                                                                   |                 |       |         |         |            |

***注意：只有写在 `#group_info`中的组才会进行富集和比较分析。***

#### parameter.json

* species（物种）：mouse、human
* sample_sheet：上一步制作的sample_sheet表格路径
* output_dir：样本分析结果输出路径
* pipeline_root：流程路径（本README所在文件夹路径）

## 使用方法

```bash
nextflow -log /path/to/project/work/run.log run /path/to/rnaseq4km/rnaseq_pipeline.nf -params-file /path/to/rnaseq4km/test/parameter.json -c /path/to/rnaseq4km/nextflow.config -with-apptainer -w /path/to/project/work -resume
```

参数说明：

* -log：流程日志输出路径；
* -params-file：parameter.json路径；
* -c：nextflow.config路径；
* -with-apptainer：使用apptainer镜像运行；
* -w：流程工作路径（主要文件都会存储在这个路径下）；
* -resume：流程异常中断后继续中断的位置继续分析，不影响首次分析。

## 结果展示

测试命令：`nextflow -log /bioinfo/data/user010/cuity_dev/data/RNASeq/test_project/run.log  run  /bioinfo/data/user010/cuity_dev/pipeline/rnaseq4km/rnaseq_pipeline.nf -params-file /bioinfo/data/user010/cuity_dev/data/RNASeq/test_project/parameter.json -c /bioinfo/data/user010/cuity_dev/pipeline/rnaseq4km/nextflow.config -w /bioinfo/data/user010/cuity_dev/data/RNASeq/test_project/work -with-apptainer -resume`

测试结果目录：`/bioinfo/data/user010/cuity_dev/data/RNASeq/test_project/`