Repository navigation
Numeric table columns in report should be aligned right #975
Description
In a cli report table, to properly compare numbers, columns with numbers should:
- be aligned right (
\STR_PAD_LEFT). - use the same measuring unit (e.g. not
msin one record, butµsin another record). - ideally, a unit should be used where all values are > 1, so that big numbers visually stick out with additional digits to the left.
(for these last points I currently use--mode=throughput --time-unit=sas cli parameters)
For the first point, I found that the following addition in TableRenderer::render() has the desired effect for the main table:
$style = (new TableStyle())->setPadType(\STR_PAD_LEFT);
$nColumns = \count($object->columnNames());
for ($iCol = 2; $iCol < $nColumns; ++$iCol) {
$consoleTable->setColumnStyle($iCol, $style);
}However, this is obviously the wrong place to do this.
I am hard-coding the rule that every column except the first two should be aligned right, which is true for the final overview table but not universally for every table.
What the code example shows is that the symfony console table component can align numbers right.
Activity
donquixote commentedon Jan 2, 2022
Another way to do this would be per table cell.
https://symfony.com/doc/current/components/console/helpers/table.html
Perhaps we could check if the
$nodeis a number, and then decide the alignment?donquixote commentedon Jan 2, 2022
If we do this, we also have the option to print the unit in the column title, e.g. "max (ms/s)", and pure numbers in the cells.
I would say this is a little bit less readable in the cli output, but makes it easier to copy + paste and reuse this data for a spreadsheet, with some find/replace.
Although for this perhaps a dedicated csv output is preferable. I have not figured out how to do this in combination with
--report=overviewoption.dantleech commentedon Jan 2, 2022
https://phpbench.readthedocs.io/en/latest/configuration.html#runner-time-unit
Could do that here:
phpbench/lib/Report/Console/Renderer/TableRenderer.php
Line 41 in 7c26456
There is an output for that:
--output=csv:probably this boilds down to be able to configure the individual renderers (e.g. show unit or not, align numbers to the right)