diff --git a/api.html b/api.html index 15cac57..2b32760 100644 --- a/api.html +++ b/api.html @@ -1,12 +1,14 @@ - + - + API — critdd 0.0.1 documentation - - + + + + @@ -180,12 +182,12 @@

2D sequences of CD diagrams2d_example.svg
-class critdd.Diagrams(X, *, diagram_names=None, treatment_names=None, maximize_outcome=False)
+class critdd.Diagrams(Xs, *, diagram_names=None, treatment_names=None, maximize_outcome=False)

A sequence of critical difference diagrams, plotted on a single 2-dimensional axis.

Parameters:
    -
  • 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.

  • diff --git a/developer-guide.html b/developer-guide.html index 37c8e24..67feca3 100644 --- a/developer-guide.html +++ b/developer-guide.html @@ -1,12 +1,14 @@ - + - + Developer guide — critdd 0.0.1 documentation - - + + + + diff --git a/genindex.html b/genindex.html index b9b4fdd..a712645 100644 --- a/genindex.html +++ b/genindex.html @@ -1,11 +1,13 @@ - + Index — critdd 0.0.1 documentation - - + + + + diff --git a/index.html b/index.html index 0ae772e..2e9996c 100644 --- a/index.html +++ b/index.html @@ -1,12 +1,14 @@ - + - + Quickstart — critdd 0.0.1 documentation - - + + + + diff --git a/manual.html b/manual.html index 819408e..49c00cf 100644 --- a/manual.html +++ b/manual.html @@ -1,12 +1,14 @@ - + - + Manual — critdd 0.0.1 documentation - - + + + + diff --git a/search.html b/search.html index 6758fe4..30c105a 100644 --- a/search.html +++ b/search.html @@ -1,11 +1,13 @@ - + Search — critdd 0.0.1 documentation - - + + + +