Dorado项目教程

1. 项目的目录结构及介绍

Dorado项目是一个开源的basecaller，用于对Oxford Nanopore读取的数据进行高效、易用的基础调用。以下是项目的目录结构及其简要介绍：

dorado/
├── .github/              # GitHub工作流和配置文件
├── .gitignore            # 指定Git应该忽略的文件和目录
├── benchmark/            # 性能测试相关文件
├── cmake/                # CMake构建系统文件
├── documentation/        # 项目文档
├── dorado/               # 主程序和库文件
├── tests/                # 测试用例和测试脚本
├── .clang-format         # Clang格式化配置文件
├── .clang-tidy           # Clang-tidy配置文件
├── .gitlab-ci.yml        # GitLab CI/CD配置文件
├── .gitmodules           # 子模块配置文件
├── .pre-commit-config.yaml # pre-commit钩子配置文件
├── CHANGELOG.md          # 更改日志
├── CMakeLists.txt        # CMake主配置文件
├── DEV.md                # 开发者文档
├── LICENCE.txt           # 许可证文件
├── README.md             # 项目说明文件

2. 项目的启动文件介绍

Dorado项目的启动主要依赖于dorado目录下的主程序。以下是一些基础的启动命令和使用方法：

• 使用Dorado对POD5文件进行基础调用：

  $ dorado basecaller hac pod5s/ > calls.bam
  

• 如果需要调用单个POD5文件，可以直接替换目录路径为文件路径。

• 如果基础调用过程中断，可以使用--resume-from标志从BAM文件中恢复：

  $ dorado basecaller hac pod5s/ --resume-from incomplete.bam > calls.bam
  

3. 项目的配置文件介绍

Dorado项目的配置主要通过以下文件进行：

• .clang-format：Clang格式化配置文件，用于维护代码风格的一致性。

• .clang-tidy：Clang-tidy配置文件，用于代码静态分析和修复。

• .gitlab-ci.yml：GitLab CI/CD配置文件，用于自动化项目的持续集成和持续部署。

• .pre-commit-config.yaml：pre-commit钩子配置文件，用于在提交代码前自动执行一些任务，如代码格式化和静态分析。

• CMakeLists.txt：CMake主配置文件，用于构建项目。开发者可以通过修改此文件来配置编译选项和依赖。

• DEV.md：开发者文档，包含了关于如何构建和开发Dorado项目的详细说明。

这些配置文件为项目的开发和维护提供了标准和自动化支持，确保了项目质量和开发效率。