diff --git a/api.html b/api.html index 15cac57..2b32760 100644 --- a/api.html +++ b/api.html @@ -1,12 +1,14 @@ - +
- +A sequence of critical difference diagrams, plotted on a single 2-dimensional axis.
X – An (m, n, k)
-shaped tensor of observations, where m
is the number of diagrams, n
is the number of observations, and k
is the number of treatments.
Xs – Observations, given either as a list of length m
of (n, k)
-shaped matrices or as an (m, n, k)
-shaped tensor, where m
is the number of diagrams, n
is the number of observations, and k
is the number of treatments.
diagram_names (optional) – The names of the m
diagrams. Defaults to None.
treatment_names (optional) – The names of the k
treatments. Defaults to None.
maximize_outcome (optional) – Whether the ranks represent a maximization (True) or a minimization (False) of the outcome. Defaults to False.