90 lines
3.4 KiB
Markdown
90 lines
3.4 KiB
Markdown
<p align="center">
|
||
<img src="./res/result.jpg" width="200" />
|
||
</p>
|
||
<h1 align="center">
|
||
<img src="./res/app.png" width="30" style="vertical-align: middle;" />
|
||
<span style="vertical-align: middle;">CircosHeatmap-aardio</span>
|
||
</h1>
|
||
<p align="center">
|
||
一个基于 R 语言的环形热图绘制工具
|
||
</p>
|
||
|
||
<div align="center">
|
||
<a href="./README.md">English</a>
|
||
</div>
|
||
|
||
---
|
||
|
||
## 📃 项目简介
|
||
|
||
CircosHeatmap-aardio 是一个基于 R 语言的环形热图（Circos Heatmap）绘制工具，支持矩阵数据的聚类与可视化。通过 Aardio 实现图形界面，用户无需编写代码即可轻松使用该工具。
|
||
|
||
---
|
||
|
||
## ✨ 核心功能
|
||
|
||
- **环形热图绘制**：基于 R 的 `circlize` 和 `ComplexHeatmap` 包，支持矩阵数据的聚类与可视化。
|
||
- **图形界面**：使用 Aardio 实现图形界面，用户可以通过界面选择输入文件、设置参数并运行脚本。
|
||
- **代码可视化与调试**：内置 R 代码编辑框，用户可查看和修改当前执行的 R 脚本，便于自定义调试。
|
||
- **日志输出**：提供日志窗口，实时显示脚本执行结果和错误信息。
|
||
|
||
---
|
||
|
||
## 🚀 使用教程
|
||
|
||
### 1. 下载并解压
|
||
从 [Releases](./releases) 下载并解压 CircosHeatmap-aardio。
|
||
|
||
### 2. 运行程序
|
||
运行 `CircosHeatmap-aardio.exe`，首次运行时会自动安装 R 环境。
|
||
|
||
|
||
|
||
### 3. 选择数据源
|
||
点击 **“数据源”** 选择 csv 格式的表格文件。
|
||
|
||
> **注意**：当前仅支持 csv 格式的数据源。如果您的数据是其他格式（如 xls、xlsx），可以将其转换为 csv 格式后再使用。
|
||
|
||
### 4. 生成 PDF
|
||
点击 **“生成 PDF”** 选择 PDF 保存的位置。
|
||
|
||
---
|
||
|
||
## 🛠️ 程序功能细节
|
||
|
||
### 界面布局
|
||
- **R 代码编辑框**：显示当前执行的 R 脚本，用户可查看和修改代码。
|
||
- **日志窗口**：实时显示脚本执行结果和错误信息。
|
||
- **数据源选择**：通过按钮选择输入文件，支持 csv 格式。
|
||
- **生成 PDF**：运行 R 脚本并保存生成的环形热图为 PDF 文件。
|
||
|
||
### 代码逻辑
|
||
- **R 脚本加载**：程序启动时自动加载默认的 R 脚本（`heatmap_script.R`）。
|
||
- **文件选择**：点击 **“数据源”** 按钮选择输入文件，路径显示在输入框中。
|
||
- **脚本执行**：点击 **“生成 PDF”** 按钮后，程序调用 R 脚本并传入输入文件路径和输出 PDF 路径。
|
||
|
||
---
|
||
|
||
## 📝 TODO
|
||
|
||
- **优化 UI**：进一步提升用户交互体验。
|
||
- **支持更多文件格式**：扩展支持 xls、xlsx 等格式。
|
||
- **增加高级功能**：如自定义颜色梯度、调整聚类参数等。
|
||
|
||
---
|
||
|
||
## ✨ 贡献
|
||
|
||
欢迎贡献、建议、错误报告和修复！如果您有任何想法或问题，请随时提交 [Issue](./issues/new) 或 [Pull Request](#pull-request-说明)。
|
||
|
||
---
|
||
|
||
## ❓ Pull Request 说明
|
||
|
||
**Pull Request（PR）** 是一种向项目贡献代码的方式。具体步骤如下：
|
||
|
||
1. **Fork 项目**：点击项目页面的 `Fork` 按钮，将项目复制到您的账号下。
|
||
2. **创建分支**：在您的 Fork 仓库中创建一个新分支，用于开发新功能或修复问题。
|
||
3. **提交更改**：在新分支上完成代码修改后，提交更改。
|
||
4. **发起 Pull Request**：在您的 Fork 仓库页面，点击 `New Pull Request`，选择您的分支并提交 PR。
|
||
5. **等待审核**：项目维护者会审核您的代码，确认无误后合并到主分支。 |