-
Notifications
You must be signed in to change notification settings - Fork 0
CLI Reference
shijiashuai edited this page Mar 9, 2026
·
1 revision
FastQTools 提供 stat 和 filter 两个子命令,用于 FASTQ 文件的统计分析和质量过滤。
FastQTools [全局选项] <子命令> [子命令选项]
全局选项必须位于子命令之前。
| 选项 | 说明 |
|---|---|
-v, --verbose |
启用调试日志(等价于 --log-level=debug) |
-q, --quiet |
仅输出错误(等价于 --log-level=error) |
--log-level=LEVEL |
设置日志级别:trace, debug, info, warn, error
|
--help |
显示帮助信息 |
默认日志级别为 info。
对 FASTQ 文件进行全面的质量统计分析。
FastQTools stat -i <input> -o <output> [选项]
| 选项 | 说明 |
|---|---|
-i, --input <path> |
输入 FASTQ 文件(支持 .gz 压缩) |
-o, --output <path> |
输出统计文件 |
-t, --threads <N> |
线程数(默认自动检测) |
--batch-size <N> |
每批处理的 reads 数量 |
| 指标 | 说明 |
|---|---|
| 读段统计 | 总读段数、有效读段数 |
| 长度分布 | 最小/最大/平均长度 |
| 质量分析 | Q20/Q30 碱基百分比 |
| 碱基组成 | A/T/C/G/N 比例 |
| GC 含量 | 整体和位置特异性 |
# 基本统计 FastQTools stat -i reads.fq.gz -o analysis.txt # 多线程处理 FastQTools stat -i reads.fq.gz -o analysis.txt -t 8 # 调试模式 FastQTools -v stat -i reads.fq.gz -o analysis.txt
对原始测序数据进行清洗、过滤和质量修剪。
FastQTools filter -i <input> -o <output> [选项]
| 选项 | 说明 |
|---|---|
-i, --input <path> |
输入 FASTQ 文件(支持 .gz) |
-o, --output <path> |
输出 FASTQ 文件(.gz 后缀自动压缩) |
-t, --threads <N> |
线程数 |
--min-quality <float> |
最小平均质量阈值 |
--min-length <int> |
最小读长 |
--max-length <int> |
最大读长 |
--max-n-ratio <0.0-1.0> |
最大 N 碱基比例 |
| 选项 | 说明 |
|---|---|
--trim-quality <float> |
质量修剪阈值 |
--trim-mode <mode> |
修剪模式:both(两端)、five(5' 端)、three(3' 端) |
# 质量过滤 FastQTools filter -i input.fq.gz -o filtered.fq.gz \ --min-quality 20 --min-length 50 # 质量修剪(从 3' 端移除低质量碱基) FastQTools filter -i input.fq.gz -o trimmed.fq.gz \ --trim-quality 20 --trim-mode three # 组合过滤 + 修剪(典型 QC 流程) FastQTools filter -i input.fq.gz -o clean.fq.gz \ --min-quality 20 --min-length 50 --max-n-ratio 0.1 \ --trim-quality 20 --trim-mode both # 静默模式 FastQTools -q filter -i input.fq.gz -o filtered.fq.gz --min-quality 20
| 退出码 | 含义 |
|---|---|
0 |
成功 |
非 0
|
错误(未知子命令、参数错误、运行时异常等) |
以 FASTQTOOLS_ 为前缀的环境变量会自动加载为配置项:
export FASTQTOOLS_THREADS=8 export FASTQTOOLS_BATCH_SIZE=100000 FastQTools stat -i input.fastq -o output.txt # threads=8, batch_size=100000 自动生效
命令行参数优先级高于环境变量。
配置优先级:默认值 → 配置文件 → 环境变量 → 命令行参数
| 参数 | 建议值 | 说明 |
|---|---|---|
--threads |
CPU 核心数 | 并行线程数 |
--batch-size |
10000–100000 | 每批 reads 数量 |
对于大文件(>1GB),建议使用多线程 + 大 batch size 以获得最佳吞吐量。
- Getting Started — 环境搭建与第一个示例
- API Reference — 作为 C++ 库集成
- Performance Benchmarks — 性能基准数据
FastQTools v3.1.0
🚀 快速上手
🏗️ 架构与设计
🔧 构建与部署
🧪 质量工程
📖 规范与参考
🔗 外部链接