discrimintools.summaryPLSDA

discrimintools.summaryPLSDA(obj, digits=4, detailed=False, to_markdown=False, tablefmt='github', **kwargs)

Printing summaries of Partial Least Squares Discriminant Analysis model.

Parameters:

• obj (class) – An object of class PLSDA.

• digits (int, default = 4) – The number of decimal printed.

• detailed (bool, default = False) – To print detailed summaries.

• to_markdown (bool, default = False) – To print summaries in markdown-friendly format. Requires the tabulate. package.

• tablefmt (str, default = “github”) – The table format.

• **kwargs – additionals parameters. These parameters will be passed to tabulate.

Return type:

NoneType

See also

summaryCANDISC

Printing summaries of Canonical Discriminant Analysis model.

summaryCPLS

Printing summaries of Partial Least Squares for Classification model.

summaryDA

Printing summaries of Discriminant Analysis model.

summaryDiCA

Printing summaries of Discriminant Correspondence Analysis model.

summaryDISCRIM

Printing summaries of Discriminant Analysis (linear and quadratic) model.

summaryGFALDA

Printing summaries of General Factor Analysis Linear Discriminant Analysis model.

summaryMDA

Printing summaries of Mixed Discriminant Analysis model.

summaryPLSLDA

Printing summaries of Partial Least Squares Linear Discriminant Analysis model.

summarySTEPDISC

Printing summaries of Stepwise Discriminant Analysis model.

Examples

>>> from discrimintools.datasets import load_dataset
>>> from discrimintools import PLSDA, summaryPLSDA
>>> D = load_dataset("breast")
>>> y, X = D["Class"], D.drop(columns=["Class"])
>>> clf = PLSDA()
>>> clf.fit(X,y)
PLSDA()
>>> summaryPLSDA(clf)
                    Partial Least Squares Discriminant Analysis - Results
Class Level Information:
          Frequency  Proportion  Prior Probability
negative        458      0.6552             0.6552
positive        241      0.3448             0.3448
Importance of PLS components:
      Proportion (%)  Cumulative (%)
Can1         69.1520         69.1520
Can2         20.1981         89.3501
Classification functions coefficients:
           negative  positive     VIP
Constant     1.0801   -0.0801     NaN
ucellsize   -0.0853    0.0853  1.2038
normnucl    -0.0533    0.0533  1.0346
mitoses     -0.0030    0.0030  0.6933