开源项目 cd-diagram 使用文档

开源项目 cd-diagram 使用文档

cd-diagramCritical difference diagram with Wilcoxon-Holm post-hoc analysis. 项目地址:https://gitcode.com/gh_mirrors/cd/cd-diagram

项目的目录结构及介绍

cd-diagram/
├── .gitignore
├── LICENSE
├── README.md
├── cd-diagram.png
├── example.csv
├── main.py
└── requirements.txt

• .gitignore: 用于指定Git版本控制系统忽略的文件和文件夹。
• LICENSE: 项目的许可证文件，本项目使用GPL-3.0许可证。
• README.md: 项目说明文档，包含项目的基本信息和使用说明。
• cd-diagram.png: 示例生成的关键差异图。
• example.csv: 示例数据文件，用于生成关键差异图。
• main.py: 项目的启动文件，包含生成关键差异图的代码。
• requirements.txt: 项目依赖的Python库列表。

项目的启动文件介绍

main.py

main.py 是项目的启动文件，主要功能是读取 example.csv 文件中的数据，并生成关键差异图。以下是文件的主要内容：

import pandas as pd
from cd_diagram import CriticalDifferenceDiagrams

# 读取数据
url = "https://raw.githubusercontent.com/hfawaz/cd-diagram/master/example.csv"
df = pd.read_csv(url)

# 生成关键差异图
plot = CriticalDifferenceDiagrams.plot(
    df,
    classifier_name='classifier_name',  # 处理名称列
    dataset_name='dataset_name',        # 数据集名称列
    accuracy='accuracy',                # 结果列
    maximize_outcome=True,              # 最大化结果
    title="Critical Difference Diagram",# 图表标题
    alpha=0.05,                         # 显著性水平
    adjustment='holm'                   # 调整方法
)

# 配置PGFPlots的前言（可选）
CriticalDifferenceDiagrams.pushPGFPlotsPreamble("""
\\usepackage[lmodern]
""")

# 导出为SVG、TeX或PDF
CriticalDifferenceDiagrams.save("example.svg", plot)

项目的配置文件介绍

requirements.txt

requirements.txt 文件列出了项目运行所需的Python库，可以通过以下命令安装这些依赖：

pip install -r requirements.txt

文件内容示例：

pandas
cd-diagram

以上是 cd-diagram 项目的基本使用文档，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。

cd-diagramCritical difference diagram with Wilcoxon-Holm post-hoc analysis. 项目地址:https://gitcode.com/gh_mirrors/cd/cd-diagram