# HLATyper

**Repository Path**: sculab/HLATyper

## Basic Information

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

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-09
- **Last Updated**: 2026-03-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# HLATyper

**其他语言版本: [English](README.md)**

## 1. 介绍

HLATyper 是一个基于本地 IMGT/HLA 参考数据库的 HLA-A / HLA-B / HLA-C 分型脚本工具，面向单样本测序数据（FASTQ/FASTA），输出样本在 A/B/C 位点的两条等位基因结果，并生成可追溯的差异位点表。

> 注意：本项目**不包含 barcode 拆分（demultiplex）**逻辑。若你的测序数据是多样本混合，需要先用外部工具拆分后再逐样本运行本流程。

---

## 2 运行环境与依赖

### 2.1 系统要求
- Linux（推荐）

### 2.2 关键依赖
#### Python 包
- biopython
- numpy
- pandas
- scipy
- scikit-learn

#### 外部命令行工具（必须）
- NCBI BLAST+（`blastn`, `makeblastdb`）
- MView（`mview`）


---

## 3 安装

### 3.1安装前准备
#### 下载安装软件
1.BLAST
2.MView

#### 下载运行代码
1.新建`HLATyper`文件夹
2.将`code`中文件下载到`HLATyper`文件夹中
或者你可以选择直接克隆此项目：
```bash
git clone https://gitee.com/sculab/HLATyper.git
```

#### 下载数据库
下载[IMGT-HLA 数据库](https://github.com/ANHIG/IMGTHLA/tree/Latest/fasta)中:
hla_gen_A.fasta, hla_gen_B.fasta, hla_gen_C.fasta,
hla_nuc_A.fasta, hla_nuc_B.fasta, hla_nuc_C.fasta，
hla_gen.fasta, hla_nuc.fasta
将这8个文件放入运行代码所在文件夹下db文件夹内，即如果你将`HLATyper`系列代码放在`/home/path/HLATyper`中，你需要将上述fasta文件放入`/home/path/HLATyper/db`中。

### 3.2环境搭建
新建python虚拟环境:
```bash
conda create -n HLATyper python=3.10 -y
conda activate HLATyper
```

安装`requirements`:
```bash
pip install -r requirments.txt
```

### 3.3运行
下面为简单的运行示范：
```bash
python HLATyper.py -i ./input_file -o ./output_file -s 1 -b hla_gen_A -t 10 -x A
```
其中`input_file`为测序数据存放文件夹，每个fastq\fasta文件只能包含单个样品。

命令行参数：
```bash
'-i', '--input_dir', '输入FastQ目录'
'-o', '--output_dir', '输出目录（含中间文件和最终结果）'
'-e', '--extensions', '需要处理的FastQ扩展名' default=['fq', 'fastq', 'fas', 'fasta', 'fa'],
'-b', '--input_db', help='Path to the input db file',default="hla_gen"
'-t', '--threads', '最大并行线程数（默认使用CPU核心数）'
'-s', '--steps', '从第几步开始执行（默认从第1步开始）'
'-x', '--suffix', help='输出文件名后缀'
```