diff --git a/README.md b/README.md index d8efc73..b744990 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,56 @@ -# CircosHeatmap-aardio +
+ +
++ 一个基于 R 语言的环形热图绘制工具 +
-## 项目简介 +## 📃 项目简介 CircosHeatmap-aardio 是一个基于 R 语言的环形热图(Circos Heatmap)绘制工具,支持矩阵数据的聚类与可视化。通过 Aardio 实现图形界面,使得用户无需编写代码即可轻松使用该工具。项目旨在为科研人员、数据分析师等提供一种直观、便捷的数据可视化方式。 ![demo](./res/demo.jpg) -## 核心功能 +## ✨ 核心功能 -环形热图绘制:基于 R 的 circlize 和 ComplexHeatmap 包,支持矩阵数据的聚类与可视化。 +- **环形热图绘制**:基于 R 的 circlize 和 ComplexHeatmap 包,支持矩阵数据的聚类与可视化。 +- **图形界面**:使用 Aardio 实现图形界面,用户可以通过界面选择输入文件、设置参数并运行脚本。 +- **TODO: 自动文件格式转换**:支持自动识别 xls、xlsx、csv 文件格式,并在需要时转换为符合 R 脚本要求的临时 csv 文件。 -图形界面:使用 Aardio 实现图形界面,用户可以通过界面选择输入文件、设置参数并运行脚本。 +## 📝 TODO -TODO: 自动文件格式转换:支持自动识别 xls、xlsx、csv 文件格式,并在需要时转换为符合 R 脚本要求的临时 csv 文件。 +- **优化 UI**:进一步提升用户交互体验,增加更多可视化选项。 +- **支持更多文件格式**:扩展支持更多数据文件格式。 +- **增加高级功能**:如自定义颜色梯度、调整聚类参数等。 +- **待补充**。 -## TODO +## 🛠️ 开发 -- 优化 UI:进一步提升用户交互体验,增加更多可视化选项 +1. 将 Windows 当前用户下 `appData` 目录中的 `aardio/std/r/site-library` 内容拷贝到项目中 —— 当前仓库已包含,可不用关注。 +2. 将 `aardio\lib\process\r\_.aardio` 文件中: + ```aardio + setLibPaths({..io.appData("aardio/std/r/site-library")}); + ``` + 修改为: + ```aardio + if (_STUDIO_INVOKED) { + // 开发环境 + setLibPaths({..io.appData("aardio/std/r/site-library")}); + } else { + // 打包后环境 + setLibPaths({"lib\r-library"}); + } + ``` -- 支持更多文件格式:扩展支持更多数据文件格式 +**修改目的**:初次接触 aardio + R 的开发,安装 R 的相关库时遇到无法安装部分 R 库的问题,所以干脆把安装好的 R 相关库放入程序根目录下,便于将程序分发给别人使用。 -- 增加高级功能:如自定义颜色梯度、调整聚类参数等 +**缺点**:R 库体积偏大,100MB+,不过真正需要的人应该不在乎体积吧。 -- 待补充 +## 🚀 使用 +运行后会自动安装 R 语言环境。 -## 开发 +## ✨ 贡献 -1、将 Windows 当前用户下 appData 目录中的 aardio/std/r/site-library 内容拷贝到项目中 ---- 当前仓库已包含,可不用关注 - -2、将 `aardio\lib\process\r\_.aardio` 文件中: -```aardio -setLibPaths({..io.appData("aardio/std/r/site-library")}); -``` -修改为: -```aardio - if (_STUDIO_INVOKED) { - // 开发环境 - setLibPaths({..io.appData("aardio/std/r/site-library")}); - } else { - // 打包后环境 - setLibPaths({"lib\r-library"}); - } -``` - -修改它的目的:初次接触 aardio + R 的开发,安装 R 的相关库时遇到无法安装部分 R 库的问题,所以干脆把安装好的 R 相关库放入程序根目录下,便于将程序分发给别人使用。 -这样做缺点:R 库体积偏大,100MB+,不过真正需要的人应该不在乎体积吧 - -## 使用 - -运行后会自动安装 R 语言环境 \ No newline at end of file +欢迎贡献、建议、错误报告和修复! \ No newline at end of file diff --git a/res/result.jpg b/res/result.jpg new file mode 100644 index 0000000..8e71b39 Binary files /dev/null and b/res/result.jpg differ