NextDenovo 项目使用文档

1. 项目目录结构及介绍

NextDenovo 项目的目录结构如下：

NextDenovo/
├── doc/
│   ├── run.cfg
│   ├── FAQ.md
│   ├── OPTION.md
│   └── ...
├── lib/
│   ├── nextcorrect.py
│   ├── nextgraph.py
│   └── ...
├── minimap2/
│   ├── minimap2
│   └── ...
├── test_data/
│   ├── input.fofn
│   ├── run.cfg
│   └── ...
├── util/
│   ├── utility1.py
│   ├── utility2.py
│   └── ...
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
└── VERSION

目录介绍

• doc/: 包含项目的配置文件示例、常见问题解答（FAQ）和参数参考文档。
• lib/: 包含 NextDenovo 的核心模块，如 nextcorrect.py 和 nextgraph.py。
• minimap2/: 包含 Minimap2 工具，用于序列比对。
• test_data/: 包含测试数据和示例配置文件。
• util/: 包含各种实用工具脚本。
• .gitignore: Git 忽略文件列表。
• LICENSE: 项目许可证文件。
• Makefile: 用于编译和测试项目的 Makefile。
• README.md: 项目介绍和使用说明。
• VERSION: 项目版本号文件。

2. 项目启动文件介绍

NextDenovo 的启动文件是 nextdenovo，位于项目根目录下。该文件是一个可执行脚本，用于启动 NextDenovo 的各个模块。

启动命令示例

./nextdenovo test_data/run.cfg

参数说明

• test_data/run.cfg: 配置文件路径，指定运行参数和输入数据。

3. 项目的配置文件介绍

NextDenovo 的配置文件是一个 .cfg 文件，通常命名为 run.cfg。该文件包含了运行 NextDenovo 所需的所有参数。

配置文件示例

[General]
read_type = clr
genome_size = 3000000000

[correct]
seed_cutoff = 10000

[assemble]
min_contig_length = 500

配置文件参数说明

• [General]: 通用配置项

  • read_type: 读取类型，如 clr、hifi 或 ont。
  • genome_size: 基因组大小。

• [correct]: 错误纠正模块配置项

  • seed_cutoff: 种子序列的最小长度。

• [assemble]: 组装模块配置项

  • min_contig_length: 最小 contig 长度。

通过修改配置文件中的参数，可以定制 NextDenovo 的运行行为，以适应不同的数据和需求。