Merge pull request #38 from RicardoRyn/dev

Dev

Author: RicardoRyn

README.md

@@ -3,7 +3,7 @@
 ## 简介
 
 `plotfig` 是一个专为科学数据可视化设计的 Python 库，致力于为认知神经科研工作人员提供高效、易用且美观的图形绘制工具。
-该项目基于业界主流的可视化库—— `matplotlib`、`surfplot` 和 `plotly`等库开发，融合了三者的强大功能，能够满足神经科学、脑连接组学、相关性分析、矩阵可视化等多种科研场景下的复杂绘图需求。
+该项目基于业界主流的可视化库—— `matplotlib`、`surfplot` 和 `plotly`等库开发，融合了三者的强大功能，能够满足神经科学以及脑连接组学中多种场景下的复杂绘图需求。
 
 ![plotfig](https://github.com/RicardoRyn/plotfig/blob/main/docs/assets/plotfig.png)
 
@@ -40,7 +40,7 @@ cd plotfig
 pip install .
 ```
 
-### 依赖要求
+## 依赖
 
 `plotfig` 依赖若干核心库，这些依赖将在安装过程中自动处理，但需要注意：
 
@@ -50,7 +50,7 @@ pip install .
 >
 > 由于 PyPI 上的 `surfplot` 版本较旧，缺少 `plotfig` 所需功能，建议通过以下步骤安装其 GitHub 仓库的最新版。
 >
-> 如果您无须绘制 brain_surface 图，可以忽略此步骤。
+> 如果您无须绘制 `brain surface` 图，可以忽略此步骤。
 
 ```bash
 # 卸载旧版本
@@ -66,19 +66,24 @@ cd ..
 rm -rf surfplot
 ```
 
-## 贡献指南
+## 贡献
 
-如果您希望参与 `plotfig` 的开发，或者想体验尚未正式发布的新功能，可以选择以开发模式安装项目。
-这种“可编辑模式（editable mode）”安装方式允许您对本地源码的修改立即生效，非常适合开发、调试和贡献代码。
+**_`dev` 分支通常包含最新功能以及尚未合并到 `main` 的修复。_**
 
-推荐先 Fork 仓库，然后克隆您自己的 Fork：
+如果您希望体验这些功能或参与 `plotfig` 的开发，可以选择以 开发模式（editable mode） 安装项目。
+
+这种安装方式允许您对本地源码的修改立即生效，非常适合调试、开发和贡献代码。
+
+推荐先 Fork 仓库，然后克隆您自己的 Fork 并安装 `dev` 分支：
 
 ```bash
-git clone -b dev https://github.com/<your-username >/plotfig.git
+git clone -b dev https://github.com/ <your-username >/plotfig.git
 cd plotfig
 pip install -e .
 ```
 
+---
+
 **欢迎提交 Issue 或 PR！**
 
 无论是 Bug 报告、功能建议、还是文档改进。

docs/index.md

@@ -1,13 +1,13 @@
 # 简介
 
 `plotfig` 是一个专为科学数据可视化设计的 Python 库，致力于为认知神经科研工作人员提供高效、易用且美观的图形绘制工具。
-该项目基于业界主流的可视化库—— `matplotlib`、`surfplot` 和 `plotly`等库开发，融合了三者的强大功能，能够满足神经科学、脑连接组学、相关性分析、矩阵可视化等多种科研场景下的复杂绘图需求。
+该项目基于业界主流的可视化库—— `matplotlib`、`surfplot` 和 `plotly`等库开发，融合了三者的强大功能，能够满足神经科学以及脑连接组学中多种场景下的复杂绘图需求。
 
 ![plotfig](./assets/plotfig.png)
 
 ## 项目结构
 
-项目采用模块化设计，核心代码位于 `src/plotfig/` 目录下，包含如下主要功能模块：
+项目采用模块化设计，包含如下主要功能模块：
 
 - `bar.py`：条形图绘制，适用于分组数据的对比展示。
 - `correlation.py`：相关性矩阵可视化，便于分析变量间的相关性分布。
@@ -18,9 +18,9 @@
 
 ## 特性
 
-`plotfig` API 设计简洁，参数灵活，适合科研人员和数据分析师快速集成到自己的数据分析流程中。
-其模块化架构便于后续功能扩展和自定义开发。
-结合 `matplotlib` 支持矢量图或高分辨率位图和交互式 HTML 输出，适合论文发表和学术展示。
+- `plotfig` API 设计简洁，参数灵活，适合科研人员和数据分析师快速集成到自己的数据分析流程中。
+- 其模块化架构便于后续功能扩展和自定义开发。
+- 结合 `matplotlib` 支持矢量图或高分辨率位图和交互式 HTML 输出，适合论文发表和学术展示。
 
 ---
 

docs/installation.md

@@ -1,6 +1,6 @@
 # 安装
 
-## 普通安装
+## 安装方式
 
 `plotfig` 支持通过 `pip` 或源码安装，要求 Python 3.11 及以上版本。
 
@@ -28,7 +28,7 @@ pip install .
 
     由于 PyPI 上的 `surfplot` 版本较旧，缺少 `plotfig` 所需功能，建议通过以下步骤安装其 GitHub 仓库的最新版。
 
-    如果您无须绘制 brain_surface 图，可以忽略此步骤。
+    如果您无须绘制 `brain surface` 图，可以忽略此步骤。
 
     ```bash
     # 卸载旧版本
@@ -46,17 +46,22 @@ pip install .
 
 ## 贡献指南
 
-如果您希望参与 `plotfig` 的开发，或者想体验尚未正式发布的新功能，可以选择以开发模式安装项目。
-这种“可编辑模式（editable mode）”安装方式允许您对本地源码的修改立即生效，非常适合开发、调试和贡献代码。
+**_`dev` 分支通常包含最新功能以及尚未合并到 `main` 的修复。_**
 
-推荐先 Fork 仓库，然后克隆您自己的 Fork：
+如果您希望体验这些功能或参与 `plotfig` 的开发，可以选择以 开发模式（editable mode） 安装项目。
+
+这种安装方式允许您对本地源码的修改立即生效，非常适合调试、开发和贡献代码。
+
+推荐先 Fork 仓库，然后克隆您自己的 Fork 并安装 `dev` 分支：
 
 ```bash
-git clone -b dev https://github.com/<your-username>/plotfig.git
+git clone -b dev https://github.com/ <your-username >/plotfig.git
 cd plotfig
 pip install -e .
 ```
 
+---
+
 **欢迎提交 Issue 或 PR！**
 
 无论是 Bug 报告、功能建议、还是文档改进。

src/plotfig/bar.py

@@ -343,7 +343,7 @@ def plot_one_group_bar_figure(
         colors_end (list[str] | None, optional):
             渐变色的结束颜色列表. Defaults to None.
         show_dots (bool, optional):
-            是否显示散点. Defaults to False.
+            是否显示散点. Defaults to True.
         dots_color (list[list[str]] | None, optional):
             散点的颜色列表. Defaults to None.
         y_lim (list[Num] | tuple[Num, Num] | None, optional):
@@ -444,7 +444,6 @@ def plot_one_group_bar_figure(
         # 创建随机数生成器
         rng = np.random.default_rng(seed=42)
         scatter_x = rng.normal(i, 0.1, len(d))
-        print(scatter_x)
         scatter_positions.append(scatter_x)
     if errorbar_type == "sd":
         error_values = sds

src/plotfig/circos.py

@@ -95,6 +95,7 @@ def plot_circos_figure(
     node_colors: list[str] | None = None,
     node_space: float = 0.0,
     node_label_fontsize: int = 10,
+    node_label_orientation: Literal["vertical", "horizontal"] = "horizontal",
     vmin: float | None = None,
     vmax: float | None = None,
     cmap: str | None = None,
@@ -114,6 +115,7 @@ def plot_circos_figure(
         node_colors (list[str] | None, optional): 脑区颜色列表，长度应与脑区数量一致。默认为None时自动生成颜色
         node_space (float, optional): 脑区间间隔角度（度）。默认为0.0
         node_label_fontsize (int, optional): 脑区标签字体大小。默认为10
+        node_label_orientation (Literal["vertical", "horizontal"], optional): 脑区标签方向。默认为"horizontal"
         vmin (float | None, optional): 连接强度颜色映射的最小值。默认为None时根据数据自动确定
         vmax (float | None, optional): 连接强度颜色映射的最大值。默认为None时根据数据自动确定
         cmap (str | None, optional): 颜色映射表名称。默认为None时根据edge_color生成
@@ -190,7 +192,7 @@ def plot_circos_figure(
     for sector in circos.sectors:
         if sector.name.startswith("_gap"):
             continue
-        sector.text(sector.name, size=node_label_fontsize)
+        sector.text(sector.name, size=node_label_fontsize, orientation=node_label_orientation)
         track = sector.add_track((95, 100))
         track.axis(fc=name2color[sector.name])