pyGenomeTracks 项目教程

1. 项目目录结构及介绍

pyGenomeTracks 项目的目录结构如下：

pyGenomeTracks/
├── docs/
├── examples/
├── pygenometracks/
├── .gitignore
├── readthedocs.yml
├── CONTRIBUTING.md
├── LICENSE
├── MANIFEST.in
├── README.md
├── azure-pipelines.yml
├── environment.yml
├── pyproject.toml
├── requirements.txt
├── requirements_CI.txt
└── test_locally.sh

目录结构介绍

• docs/: 包含项目的文档文件，通常用于生成项目的文档网站。
• examples/: 包含示例配置文件和数据文件，帮助用户快速上手。
• pygenometracks/: 项目的核心代码目录，包含所有用于生成基因组浏览器轨迹的Python模块和脚本。
• .gitignore: Git 忽略文件，指定哪些文件和目录不需要被版本控制。
• readthedocs.yml: 用于配置 Read the Docs 文档服务的文件。
• CONTRIBUTING.md: 贡献指南，指导开发者如何为项目贡献代码。
• LICENSE: 项目的开源许可证文件，本项目使用 GPL-3.0 许可证。
• MANIFEST.in: 用于指定在打包项目时需要包含的非 Python 文件。
• README.md: 项目的介绍文件，包含项目的基本信息、安装指南和使用说明。
• azure-pipelines.yml: 用于配置 Azure Pipelines 的持续集成文件。
• environment.yml: Conda 环境配置文件，用于创建项目的运行环境。
• pyproject.toml: 用于配置项目构建系统的文件，支持 Poetry 等工具。
• requirements.txt: 项目依赖的 Python 包列表。
• requirements_CI.txt: 用于持续集成的额外依赖包列表。
• test_locally.sh: 本地测试脚本，用于在本地环境中运行测试。

2. 项目启动文件介绍

pyGenomeTracks 项目的启动文件是 pygenometracks/main.py。这个文件包含了项目的主要入口点，负责解析命令行参数并调用相应的功能模块来生成基因组浏览器轨迹。

主要功能

• 命令行参数解析: 使用 argparse 模块解析用户输入的命令行参数。
• 配置文件加载: 加载用户提供的配置文件，解析其中的轨迹信息。
• 轨迹生成: 根据配置文件中的信息，调用相应的模块生成基因组浏览器轨迹。
• 输出结果: 将生成的轨迹图像保存为用户指定的格式（如 PDF、PNG、SVG）。

3. 项目的配置文件介绍

pyGenomeTracks 使用一个配置文件来描述需要绘制的基因组轨迹。配置文件通常是一个 .ini 格式的文件，可以通过 make_tracks_file 工具生成。

配置文件示例

[track1]
file = example.bw
type = bigwig
title = BigWig Track

[track2]
file = example.bed
type = bed
title = BED Track

配置文件结构

• [trackX]: 每个轨迹的配置块，X 是轨迹的编号。
• file: 轨迹数据文件的路径。
• type: 轨迹数据的类型，如 bigwig、bed 等。
• title: 轨迹的标题，显示在生成的图像中。

生成配置文件

可以使用 make_tracks_file 工具生成配置文件：

make_tracks_file --trackFiles example.bw example.bed -o tracks.ini

使用配置文件

生成配置文件后，可以使用 pyGenomeTracks 命令生成图像：

pyGenomeTracks --tracks tracks.ini --region chr2:10,000,000-11,000,000 --outFileName nice_image.pdf

这个命令将根据 tracks.ini 配置文件中的信息，生成指定区域的基因组浏览器轨迹图像，并保存为 nice_image.pdf。