BDSTest._summary_table#

BDSTest._summary_table()[source]#

Render as a table over the embedding dimensions.

Companions first and this record last, so the dimensions read upward; the header carries the radius, the sample, and the verdict, and the notes carry the reading rule for residuals and, below 500 observations, the size warning.

Return type:

SummaryTable

Returns:

The SummaryTable that str() and the notebook renderer display.

Example

>>> import numpy as np
>>> test = bds(np.random.default_rng(0).standard_normal(300), dimension=4)
>>> table = test._summary_table()
>>> [row[0] for row in table.rows], len(table.notes)
(['2', '3', '4'], 2)