From 93b7d3df49e4ab0e2cc10f9b2c99a506d91c8971 Mon Sep 17 00:00:00 2001 From: Mirko Bunse Date: Tue, 6 Jul 2021 20:13:07 +0200 Subject: [PATCH] Documentation of 2d diagrams --- README.md | 4 + docs/src/assets/2d_example.svg | 1500 ++++++++++++++++++++++++++++++++ docs/src/index.md | 9 + 3 files changed, 1513 insertions(+) create mode 100644 docs/src/assets/2d_example.svg diff --git a/README.md b/README.md index 6ae239f..6a2b72b 100644 --- a/README.md +++ b/README.md @@ -9,4 +9,8 @@ Critical difference (CD) diagrams are a powerful tool to compare outcomes of mul docs/src/assets/example.svg +You can also generate sequences of CD diagrams, which are arranged in a single 2-dimensional axis. + +docs/src/assets/2d_example.svg + For more information, please refer to [the documentation](https://mirkobunse.github.io/CriticalDifferenceDiagrams.jl/dev). diff --git a/docs/src/assets/2d_example.svg b/docs/src/assets/2d_example.svg new file mode 100644 index 0000000..90fb025 --- /dev/null +++ b/docs/src/assets/2d_example.svg @@ -0,0 +1,1500 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/src/index.md b/docs/src/index.md index 02568b6..a8fa062 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -55,6 +55,15 @@ PGFPlots.save("example.svg", plot) The hypothesis tests underneath the CD diagram do not account for variances of the outcomes. It is therefore important that these outcomes are "reliable" in the sense that each of them is obtained from a sufficiently large sample. Ideally, they come from a cross validation or from a repeated stratified split. Moreover, all treatments must have been evaluated on the same set of observations. +## 2-dimensional sequences of CD diagrams + +The [API reference](@ref) of the `plot` method provides additional information on how to generate sequences of CD diagrams, which are arranged in a single 2-dimensional axis. + +```@raw html +assets/2d_example.svg +``` + + ## Citing CD diagrams have originally been proposed in the following article: