SigProfilerMatrixGenerator 项目启动与配置教程

1. 项目目录结构及介绍

SigProfilerMatrixGenerator 是一个用于生成体细胞突变矩阵的开源项目。项目目录结构如下：

SigProfilerMatrixGenerator/
├── .gitignore
├── Dockerfile
├── LICENSE
├── MANIFEST.in
├── README.md
├── Requirements.txt
├── السرفлет
│   ├── __init__.py
│   ├── controller.py
│   ├── matrices.py
│   ├── plotting.py
│   ├── scripts.py
│   └── util.py
├── tests/
│   ├── __init__.py
│   ├── test_matrix_generator.py
│   └── test_plotting.py
└── ...

• README.md: 项目说明文件，介绍了项目的功能、安装和使用方法。
• LICENSE: 项目许可证文件，本项目采用 BSD-2-Clause 许可。
• Dockerfile: 用于创建 Docker 容器的文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• requirements.txt: 项目依赖的 Python 包列表。
• السرفлет: 包含项目的核心逻辑和功能模块。
• tests/: 包含项目的单元测试文件。

2. 项目的启动文件介绍

项目的启动主要是通过 Python 脚本实现的。以下是主要的启动文件：

• matrix_generator.py: 该脚本提供了命令行界面（CLI），用户可以通过命令行运行该脚本以生成突变矩阵。
• SigProfilerMatrixGenerator.py: 项目的入口文件，用于导入和执行项目的功能。

要启动项目，您可以使用以下命令：

python SigProfilerMatrixGenerator.py matrix_generator --project <项目名称> --reference_genome <参考基因组> --path_to_input_files <输入文件路径>

请替换 <项目名称>、<参考基因组> 和 <输入文件路径> 为您的具体项目信息。

3. 项目的配置文件介绍

项目的配置主要是通过 config.py 文件来完成的，但在此项目中没有找到明显的 config.py 文件。通常，配置文件会包含项目的设置，如数据库连接信息、路径设置、功能选项等。

在本项目中，配置主要在 matrix_generator.py 脚本中通过参数进行。以下是一些主要参数：

• --project: 指定项目名称。
• --reference_genome: 指定参考基因组名称。
• --path_to_input_files: 指定输入文件的路径。

您还可以通过以下参数进一步配置项目：

• --exome: 是否仅针对基因组的外显子区域进行 downsampling。
• --bed_file: 指定 downsampling 时使用的 BED 文件路径。
• --chrom_based: 是否输出基于染色体的矩阵。
• --plot: 是否生成可视化图形。
• --tsb_stat: 是否输出转录本链偏移测试结果。
• --seqInfo: 是否输出原始突变的分类信息。
• --cushion: 在 downsampling 期间添加的缓冲区大小。

使用这些参数，您可以按照项目需求进行配置和运行。