From 872bce55ef3c88a2b6cbd8d04b1032368199cfc0 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Mon, 6 Dec 2021 14:49:40 -1000 Subject: [PATCH] ;doc: bal: mention tidy's disabling of totals/averages (#1773, #1775) --- hledger/Hledger/Cli/Commands/Balance.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/hledger/Hledger/Cli/Commands/Balance.md b/hledger/Hledger/Cli/Commands/Balance.md index fea99c99b..62f0338fd 100644 --- a/hledger/Hledger/Cli/Commands/Balance.md +++ b/hledger/Hledger/Cli/Commands/Balance.md @@ -282,13 +282,17 @@ even when you don't have transactions in all of your declared accounts yet. ### Data layout -With `--layout`, you can influence how amounts with more than one commodity are displayed (and a bit more), -which in turn affects the layout of the report data: +The `--layout` option affects how multi-commodity amounts are displayed, +and some other things, influencing the overall layout of the report data: - `--layout=wide[,WIDTH]`: commodities are shown on a single line, possibly elided to the specified width - `--layout=tall`: each commodity is shown on a separate line - `--layout=bare`: amounts are shown as bare numbers, with commodity symbols in a separate column -- `--layout=tidy`: data is normalised to [tidy](https://cran.r-project.org/web/packages/tidyr/vignettes/tidy-data.html) form, with one row per data value (supported with CSV output only) +- `--layout=tidy`: data is normalised to [tidy] form, with one row per data value. + This is supported with CSV output format only. + Totals and row averages are disabled in this mode (`-N/--no-total` is implied and `-T/--row-total` and `-A/--average` will be ignored). + +[tidy]: https://vita.had.co.nz/papers/tidy-data.html These `--layout` values affect some but not all of the [output formats](#output-format), as shown: