MSIsensor 使用教程

项目概述

MSIsensor 是一个专用于检测微卫星不稳定性（Microsatellite Instability, MSI）的C++程序，通过分析肿瘤和正常配对样本或仅肿瘤样本的序列数据，来识别复制滑动变异体并区分其为体细胞或生殖细胞变异。该项目提供了一种有效的方法，利用皮尔逊χ²检验比较每个微卫星在正常和肿瘤样本中重复序列预期长度分布，从而判断MSI状态。

1. 目录结构及介绍

MSIsensor 的项目结构设计以清晰和模块化为核心，以下是一些关键目录的说明：

msisensor/
├── Dockerfile                # Docker容器构建文件
├── LICENSE                   # 开源许可证文件
├── README.md                 # 主要的项目说明文档
├── README_msisensor.md       # MSIsensor的具体使用说明
├── bamreader.cpp/h           # 处理BAM文件的读取类
├── bampairs.cpp/h            # 处理配对BAM文件的逻辑
├── bamtumors.cpp             # 肿瘤BAM文件处理逻辑
├── chi.cpp/h                 # 实现χ²检验相关的代码
├── cmds.cpp/h                # 命令行参数解析相关
├── distribution.cpp/h        # 分布计算相关
├── homo.cpp/h                # 同源性检测相关
├── makefile                  # 编译规则文件
├── params.cpp/h              # 参数管理相关
├── polyscan.cpp/h            # 微卫星位点扫描逻辑
├── refseq.cpp/h              # 参考序列处理
├── sample.cpp/h              # 样本处理逻辑
├── scan.cpp/h                # 微卫星区域扫描
├── somatic.cpp/h             # 体细胞变异相关处理
├── structs.h                 # 定义核心数据结构
├── test                      # 测试相关文件或目录
└── window.cpp/h              # 滑窗处理相关代码

2. 项目的启动文件介绍

MSIsensor 并没有明确标记出一个单一的“启动文件”，但其运行机制通常基于命令行接口。用户需编译项目后，通过调用可执行文件并传入相应的命令行参数来启动程序。这意味着核心的入口点隐藏于编译后的可执行文件中，通常由main()函数开始执行。

3. 项目的配置文件介绍

MSIsensor 依赖于命令行参数而非传统的独立配置文件来进行设置。用户在使用时需直接在命令行输入包括输入文件路径、输出目录、微卫星特征等在内的参数。这使得配置动态且灵活，但缺乏直观的配置文件进行长期或团队间的设置共享。若需定制化配置，建议通过脚本或环境变量间接实现。

使用示例

虽然这里没有直接的配置文件，但提供的命令行参数构成了其“配置”方式的一部分。例如，基本的运行命令可能看起来像这样：

./msisensor --input tumor.bam normal.bam --output result_dir

此命令假定了需要提供肿瘤和正常样本的BAM文件，并指定结果输出的目录。

请注意，实际的参数列表和使用细节应参考项目中的README.md和README_msisensor.md文档，以获取最新的使用指南和详细的参数说明。由于项目已归档，确保检查潜在的新版本或相关工具如 msisensor-pro 或 msisensor2，它们可能提供了更加先进的功能和更现代的配置选项。