diff --git a/hledger/hledger.1 b/hledger/hledger.1 index 5c648c66f..7584e05a3 100644 --- a/hledger/hledger.1 +++ b/hledger/hledger.1 @@ -3250,13 +3250,13 @@ commodity symbols in a separate column .IP \[bu] 2 \f[C]--layout=tidy\f[R]: 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 +We currently support this with CSV output only. +In tidy mode, totals and row averages are disabled (\f[C]-N/--no-total\f[R] is implied and \f[C]-T/--row-total\f[R] and \f[C]-A/--average\f[R] will be ignored). .PP -These \f[C]--layout\f[R] values affect some but not all of the output -formats, as shown: +These \f[C]--layout\f[R] modes are supported with some but not all of +the output formats: .PP .TS tab(@); @@ -3436,44 +3436,28 @@ $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout= Tidy layout produces normalised \[dq]tidy data\[dq], where every variable is a column and each row represents a single data point (see https://cran.r-project.org/web/packages/tidyr/vignettes/tidy-data.html). -This is the form of data most easily processed by other software. -Currently we support it with the CSV output format only: +This kind of data is the easiest to process with other software: .RS 2 .IP .nf \f[C] -$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=tidy -Y -\[dq]account\[dq],\[dq]date\[dq],\[dq]commodity\[dq],\[dq]value\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]GLD\[dq],\[dq]0\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]ITOT\[dq],\[dq]10.00\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]USD\[dq],\[dq]337.18\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]VEA\[dq],\[dq]12.00\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]VHT\[dq],\[dq]106.00\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]GLD\[dq],\[dq]70.00\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]ITOT\[dq],\[dq]18.00\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]USD\[dq],\[dq]-98.12\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]VEA\[dq],\[dq]10.00\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]VHT\[dq],\[dq]18.00\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]GLD\[dq],\[dq]0\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]ITOT\[dq],\[dq]-11.00\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]USD\[dq],\[dq]4881.44\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]VEA\[dq],\[dq]14.00\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]VHT\[dq],\[dq]170.00\[dq] -\[dq]total\[dq],\[dq]2012\[dq],\[dq]GLD\[dq],\[dq]0\[dq] -\[dq]total\[dq],\[dq]2012\[dq],\[dq]ITOT\[dq],\[dq]10.00\[dq] -\[dq]total\[dq],\[dq]2012\[dq],\[dq]USD\[dq],\[dq]337.18\[dq] -\[dq]total\[dq],\[dq]2012\[dq],\[dq]VEA\[dq],\[dq]12.00\[dq] -\[dq]total\[dq],\[dq]2012\[dq],\[dq]VHT\[dq],\[dq]106.00\[dq] -\[dq]total\[dq],\[dq]2013\[dq],\[dq]GLD\[dq],\[dq]70.00\[dq] -\[dq]total\[dq],\[dq]2013\[dq],\[dq]ITOT\[dq],\[dq]18.00\[dq] -\[dq]total\[dq],\[dq]2013\[dq],\[dq]USD\[dq],\[dq]-98.12\[dq] -\[dq]total\[dq],\[dq]2013\[dq],\[dq]VEA\[dq],\[dq]10.00\[dq] -\[dq]total\[dq],\[dq]2013\[dq],\[dq]VHT\[dq],\[dq]18.00\[dq] -\[dq]total\[dq],\[dq]2014\[dq],\[dq]GLD\[dq],\[dq]0\[dq] -\[dq]total\[dq],\[dq]2014\[dq],\[dq]ITOT\[dq],\[dq]-11.00\[dq] -\[dq]total\[dq],\[dq]2014\[dq],\[dq]USD\[dq],\[dq]4881.44\[dq] -\[dq]total\[dq],\[dq]2014\[dq],\[dq]VEA\[dq],\[dq]14.00\[dq] -\[dq]total\[dq],\[dq]2014\[dq],\[dq]VHT\[dq],\[dq]170.00\[dq] +$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -Y -O csv --layout=tidy +\[dq]account\[dq],\[dq]period\[dq],\[dq]start_date\[dq],\[dq]end_date\[dq],\[dq]commodity\[dq],\[dq]value\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012-01-01\[dq],\[dq]2012-12-31\[dq],\[dq]GLD\[dq],\[dq]0\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012-01-01\[dq],\[dq]2012-12-31\[dq],\[dq]ITOT\[dq],\[dq]10.00\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012-01-01\[dq],\[dq]2012-12-31\[dq],\[dq]USD\[dq],\[dq]337.18\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012-01-01\[dq],\[dq]2012-12-31\[dq],\[dq]VEA\[dq],\[dq]12.00\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012-01-01\[dq],\[dq]2012-12-31\[dq],\[dq]VHT\[dq],\[dq]106.00\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013-01-01\[dq],\[dq]2013-12-31\[dq],\[dq]GLD\[dq],\[dq]70.00\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013-01-01\[dq],\[dq]2013-12-31\[dq],\[dq]ITOT\[dq],\[dq]18.00\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013-01-01\[dq],\[dq]2013-12-31\[dq],\[dq]USD\[dq],\[dq]-98.12\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013-01-01\[dq],\[dq]2013-12-31\[dq],\[dq]VEA\[dq],\[dq]10.00\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013-01-01\[dq],\[dq]2013-12-31\[dq],\[dq]VHT\[dq],\[dq]18.00\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014-01-01\[dq],\[dq]2014-12-31\[dq],\[dq]GLD\[dq],\[dq]0\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014-01-01\[dq],\[dq]2014-12-31\[dq],\[dq]ITOT\[dq],\[dq]-11.00\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014-01-01\[dq],\[dq]2014-12-31\[dq],\[dq]USD\[dq],\[dq]4881.44\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014-01-01\[dq],\[dq]2014-12-31\[dq],\[dq]VEA\[dq],\[dq]14.00\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014-01-01\[dq],\[dq]2014-12-31\[dq],\[dq]VHT\[dq],\[dq]170.00\[dq] \f[R] .fi .RE diff --git a/hledger/hledger.info b/hledger/hledger.info index 3fed3c84c..10d2609ad 100644 --- a/hledger/hledger.info +++ b/hledger/hledger.info @@ -2629,12 +2629,12 @@ data: * '--layout=bare': amounts are shown as bare numbers, with commodity symbols in a separate column * '--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 + data value. We currently support this with CSV output only. In + tidy mode, totals and row averages are disabled ('-N/--no-total' is implied and '-T/--row-total' and '-A/--average' will be ignored). - These '--layout' values affect some but not all of the output -formats, as shown: + These '--layout' modes are supported with some but not all of the +output formats: - txt csv html json sql --------------------------------------- @@ -2727,41 +2727,25 @@ tidy Y * Tidy layout produces normalised "tidy data", where every variable is a column and each row represents a single data point (see https://cran.r-project.org/web/packages/tidyr/vignettes/tidy-data.html). - This is the form of data most easily processed by other software. - Currently we support it with the CSV output format only: + This kind of data is the easiest to process with other software: - $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=tidy -Y - "account","date","commodity","value" - "Assets:US:ETrade","2012","GLD","0" - "Assets:US:ETrade","2012","ITOT","10.00" - "Assets:US:ETrade","2012","USD","337.18" - "Assets:US:ETrade","2012","VEA","12.00" - "Assets:US:ETrade","2012","VHT","106.00" - "Assets:US:ETrade","2013","GLD","70.00" - "Assets:US:ETrade","2013","ITOT","18.00" - "Assets:US:ETrade","2013","USD","-98.12" - "Assets:US:ETrade","2013","VEA","10.00" - "Assets:US:ETrade","2013","VHT","18.00" - "Assets:US:ETrade","2014","GLD","0" - "Assets:US:ETrade","2014","ITOT","-11.00" - "Assets:US:ETrade","2014","USD","4881.44" - "Assets:US:ETrade","2014","VEA","14.00" - "Assets:US:ETrade","2014","VHT","170.00" - "total","2012","GLD","0" - "total","2012","ITOT","10.00" - "total","2012","USD","337.18" - "total","2012","VEA","12.00" - "total","2012","VHT","106.00" - "total","2013","GLD","70.00" - "total","2013","ITOT","18.00" - "total","2013","USD","-98.12" - "total","2013","VEA","10.00" - "total","2013","VHT","18.00" - "total","2014","GLD","0" - "total","2014","ITOT","-11.00" - "total","2014","USD","4881.44" - "total","2014","VEA","14.00" - "total","2014","VHT","170.00" + $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -Y -O csv --layout=tidy + "account","period","start_date","end_date","commodity","value" + "Assets:US:ETrade","2012","2012-01-01","2012-12-31","GLD","0" + "Assets:US:ETrade","2012","2012-01-01","2012-12-31","ITOT","10.00" + "Assets:US:ETrade","2012","2012-01-01","2012-12-31","USD","337.18" + "Assets:US:ETrade","2012","2012-01-01","2012-12-31","VEA","12.00" + "Assets:US:ETrade","2012","2012-01-01","2012-12-31","VHT","106.00" + "Assets:US:ETrade","2013","2013-01-01","2013-12-31","GLD","70.00" + "Assets:US:ETrade","2013","2013-01-01","2013-12-31","ITOT","18.00" + "Assets:US:ETrade","2013","2013-01-01","2013-12-31","USD","-98.12" + "Assets:US:ETrade","2013","2013-01-01","2013-12-31","VEA","10.00" + "Assets:US:ETrade","2013","2013-01-01","2013-12-31","VHT","18.00" + "Assets:US:ETrade","2014","2014-01-01","2014-12-31","GLD","0" + "Assets:US:ETrade","2014","2014-01-01","2014-12-31","ITOT","-11.00" + "Assets:US:ETrade","2014","2014-01-01","2014-12-31","USD","4881.44" + "Assets:US:ETrade","2014","2014-01-01","2014-12-31","VEA","14.00" + "Assets:US:ETrade","2014","2014-01-01","2014-12-31","VHT","170.00"  File: hledger.info, Node: Sorting by amount, Next: Percentages, Prev: Data layout, Up: balance @@ -9244,378 +9228,378 @@ Node: Showing declared accounts90665 Ref: #showing-declared-accounts90858 Node: Data layout91389 Ref: #data-layout91544 -Node: Sorting by amount99640 -Ref: #sorting-by-amount99795 -Node: Percentages100465 -Ref: #percentages100623 -Node: Balance change end balance101584 -Ref: #balance-change-end-balance101777 -Node: Balance report types103205 -Ref: #balance-report-types103395 -Node: Useful balance reports107674 -Ref: #useful-balance-reports107855 -Node: Budget report108940 -Ref: #budget-report109124 -Node: Budget report start date114399 -Ref: #budget-report-start-date114577 -Node: Budgets and subaccounts115909 -Ref: #budgets-and-subaccounts116116 -Node: Selecting budget goals119556 -Ref: #selecting-budget-goals119728 -Node: Customising single-period balance reports120762 -Ref: #customising-single-period-balance-reports120971 -Node: balancesheet123146 -Ref: #balancesheet123284 -Node: balancesheetequity124583 -Ref: #balancesheetequity124734 -Node: cashflow126114 -Ref: #cashflow126238 -Node: check127384 -Ref: #check127489 -Node: Basic checks128123 -Ref: #basic-checks128241 -Node: Strict checks128792 -Ref: #strict-checks128933 -Node: Other checks129369 -Ref: #other-checks129509 -Node: Custom checks129866 -Ref: #custom-checks129986 -Node: close130403 -Ref: #close130507 -Node: close and prices132598 -Ref: #close-and-prices132727 -Node: close date133122 -Ref: #close-date133306 -Node: Example close asset/liability accounts for file transition134063 -Ref: #example-close-assetliability-accounts-for-file-transition134364 -Node: Hiding opening/closing transactions135223 -Ref: #hiding-openingclosing-transactions135494 -Node: close and balance assertions136871 -Ref: #close-and-balance-assertions137129 -Node: Example close revenue/expense accounts to retained earnings138483 -Ref: #example-close-revenueexpense-accounts-to-retained-earnings138761 -Node: codes139651 -Ref: #codes139761 -Node: commodities140473 -Ref: #commodities140602 -Node: descriptions140684 -Ref: #descriptions140814 -Node: diff141118 -Ref: #diff141226 -Node: files142273 -Ref: #files142375 -Node: help142522 -Ref: #help142624 -Node: import143442 -Ref: #import143558 -Node: Deduplication144423 -Ref: #deduplication144548 -Node: Import testing146442 -Ref: #import-testing146607 -Node: Importing balance assignments147095 -Ref: #importing-balance-assignments147301 -Node: Commodity display styles147950 -Ref: #commodity-display-styles148123 -Node: incomestatement148252 -Ref: #incomestatement148387 -Node: notes149692 -Ref: #notes149807 -Node: payees150175 -Ref: #payees150283 -Node: prices150809 -Ref: #prices150917 -Node: print151286 -Ref: #print151398 -Node: print-unique156713 -Ref: #print-unique156841 -Node: register157126 -Ref: #register157255 -Node: Custom register output161701 -Ref: #custom-register-output161832 -Node: register-match163169 -Ref: #register-match163305 -Node: rewrite163656 -Ref: #rewrite163773 -Node: Re-write rules in a file165679 -Ref: #re-write-rules-in-a-file165842 -Node: Diff output format166991 -Ref: #diff-output-format167174 -Node: rewrite vs print --auto168266 -Ref: #rewrite-vs.-print---auto168426 -Node: roi168982 -Ref: #roi169082 -Node: Spaces and special characters in --inv and --pnl170768 -Ref: #spaces-and-special-characters-in---inv-and---pnl171008 -Node: Semantics of --inv and --pnl171496 -Ref: #semantics-of---inv-and---pnl171735 -Node: IRR and TWR explained173585 -Ref: #irr-and-twr-explained173745 -Node: stats176813 -Ref: #stats176914 -Node: tags178294 -Ref: #tags178394 -Node: test178913 -Ref: #test179029 -Node: About add-on commands179776 -Ref: #about-add-on-commands179913 -Node: JOURNAL FORMAT181044 -Ref: #journal-format181172 -Node: Transactions183399 -Ref: #transactions183514 -Node: Dates184528 -Ref: #dates184644 -Node: Simple dates184709 -Ref: #simple-dates184829 -Node: Secondary dates185338 -Ref: #secondary-dates185486 -Node: Posting dates186822 -Ref: #posting-dates186945 -Node: Status188317 -Ref: #status188427 -Node: Code190135 -Ref: #code190247 -Node: Description190479 -Ref: #description190607 -Node: Payee and note190927 -Ref: #payee-and-note191035 -Node: Comments191370 -Ref: #comments191492 -Node: Tags192686 -Ref: #tags-1192797 -Node: Postings194190 -Ref: #postings194314 -Node: Virtual postings195340 -Ref: #virtual-postings195451 -Node: Account names196756 -Ref: #account-names196893 -Node: Amounts197381 -Ref: #amounts197518 -Node: Decimal marks digit group marks198503 -Ref: #decimal-marks-digit-group-marks198680 -Node: Commodity199701 -Ref: #commodity199890 -Node: Directives influencing number parsing and display200842 -Ref: #directives-influencing-number-parsing-and-display201103 -Node: Commodity display style201596 -Ref: #commodity-display-style201804 -Node: Rounding203999 -Ref: #rounding204119 -Node: Transaction prices204531 -Ref: #transaction-prices204697 -Node: Lot prices lot dates207128 -Ref: #lot-prices-lot-dates207311 -Node: Balance assertions207799 -Ref: #balance-assertions207977 -Node: Assertions and ordering209010 -Ref: #assertions-and-ordering209192 -Node: Assertions and included files209892 -Ref: #assertions-and-included-files210129 -Node: Assertions and multiple -f options210462 -Ref: #assertions-and-multiple--f-options210712 -Node: Assertions and commodities210844 -Ref: #assertions-and-commodities211070 -Node: Assertions and prices212227 -Ref: #assertions-and-prices212435 -Node: Assertions and subaccounts212875 -Ref: #assertions-and-subaccounts213098 -Node: Assertions and virtual postings213422 -Ref: #assertions-and-virtual-postings213658 -Node: Assertions and precision213800 -Ref: #assertions-and-precision213987 -Node: Balance assignments214254 -Ref: #balance-assignments214424 -Node: Balance assignments and prices215588 -Ref: #balance-assignments-and-prices215754 -Node: Directives215978 -Ref: #directives216141 -Node: Directives and multiple files220633 -Ref: #directives-and-multiple-files220829 -Node: Comment blocks221521 -Ref: #comment-blocks221698 -Node: Including other files221874 -Ref: #including-other-files222048 -Node: Default year222972 -Ref: #default-year223130 -Node: Declaring payees223537 -Ref: #declaring-payees223708 -Node: Declaring the decimal mark223954 -Ref: #declaring-the-decimal-mark224154 -Node: Declaring commodities224551 -Ref: #declaring-commodities224742 -Node: Commodity error checking227260 -Ref: #commodity-error-checking227410 -Node: Default commodity227667 -Ref: #default-commodity227847 -Node: Declaring market prices228963 -Ref: #declaring-market-prices229152 -Node: Declaring accounts229965 -Ref: #declaring-accounts230145 -Node: Account error checking231347 -Ref: #account-error-checking231513 -Node: Account comments232692 -Ref: #account-comments232876 -Node: Account subdirectives233300 -Ref: #account-subdirectives233485 -Node: Account types233798 -Ref: #account-types233972 -Node: Auto-detected account types235295 -Ref: #auto-detected-account-types235450 -Node: Account display order236685 -Ref: #account-display-order236845 -Node: Rewriting accounts237996 -Ref: #rewriting-accounts238175 -Node: Basic aliases238932 -Ref: #basic-aliases239068 -Node: Regex aliases239812 -Ref: #regex-aliases239974 -Node: Combining aliases240693 -Ref: #combining-aliases240876 -Node: Aliases and multiple files242152 -Ref: #aliases-and-multiple-files242351 -Node: end aliases242930 -Ref: #end-aliases243077 -Node: Default parent account243226 -Ref: #default-parent-account243416 -Node: Periodic transactions244300 -Ref: #periodic-transactions244483 -Node: Periodic rule syntax246400 -Ref: #periodic-rule-syntax246600 -Node: Two spaces between period expression and description!247304 -Ref: #two-spaces-between-period-expression-and-description247617 -Node: Forecasting with periodic transactions248301 -Ref: #forecasting-with-periodic-transactions248600 -Node: Budgeting with periodic transactions251371 -Ref: #budgeting-with-periodic-transactions251604 -Node: Auto postings252013 -Ref: #auto-postings252149 -Node: Auto postings and multiple files254328 -Ref: #auto-postings-and-multiple-files254526 -Node: Auto postings and dates254735 -Ref: #auto-postings-and-dates255003 -Node: Auto postings and transaction balancing / inferred amounts / balance assertions255178 -Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions255523 -Node: Auto posting tags256026 -Ref: #auto-posting-tags256235 -Node: CSV FORMAT256871 -Ref: #csv-format256999 -Node: Examples259628 -Ref: #examples259731 -Node: Basic259939 -Ref: #basic260041 -Node: Bank of Ireland260583 -Ref: #bank-of-ireland260720 -Node: Amazon262182 -Ref: #amazon262302 -Node: Paypal264021 -Ref: #paypal264117 -Node: CSV rules271761 -Ref: #csv-rules271879 -Node: skip272212 -Ref: #skip272312 -Node: fields list272687 -Ref: #fields-list272826 -Node: field assignment274329 -Ref: #field-assignment274481 -Node: Field names275516 -Ref: #field-names275656 -Node: date field276036 -Ref: #date-field276156 -Node: date2 field276204 -Ref: #date2-field276347 -Node: status field276403 -Ref: #status-field276548 -Node: code field276597 -Ref: #code-field276744 -Node: description field276789 -Ref: #description-field276951 -Node: comment field277010 -Ref: #comment-field277167 -Node: account field277467 -Ref: #account-field277619 -Node: amount field278194 -Ref: #amount-field278345 -Node: currency field279590 -Ref: #currency-field279745 -Node: balance field280002 -Ref: #balance-field280136 -Node: separator280508 -Ref: #separator280640 -Node: if block281180 -Ref: #if-block281307 -Node: Matching the whole record281708 -Ref: #matching-the-whole-record281885 -Node: Matching individual fields282688 -Ref: #matching-individual-fields282894 -Node: Combining matchers283118 -Ref: #combining-matchers283316 -Node: Rules applied on successful match283629 -Ref: #rules-applied-on-successful-match283822 -Node: if table284476 -Ref: #if-table284597 -Node: end286335 -Ref: #end286449 -Node: date-format286673 -Ref: #date-format286807 -Node: decimal-mark287803 -Ref: #decimal-mark287950 -Node: newest-first288289 -Ref: #newest-first288432 -Node: include289115 -Ref: #include289248 -Node: balance-type289692 -Ref: #balance-type289814 -Node: Tips290514 -Ref: #tips290605 -Node: Rapid feedback290904 -Ref: #rapid-feedback291023 -Node: Valid CSV291475 -Ref: #valid-csv291607 -Node: File Extension291799 -Ref: #file-extension291953 -Node: Reading multiple CSV files292382 -Ref: #reading-multiple-csv-files292569 -Node: Valid transactions292810 -Ref: #valid-transactions292990 -Node: Deduplicating importing293618 -Ref: #deduplicating-importing293799 -Node: Setting amounts294832 -Ref: #setting-amounts294989 -Node: Amount signs297430 -Ref: #amount-signs297584 -Node: Setting currency/commodity298271 -Ref: #setting-currencycommodity298459 -Node: Amount decimal places299633 -Ref: #amount-decimal-places299825 -Node: Referencing other fields300137 -Ref: #referencing-other-fields300336 -Node: How CSV rules are evaluated301233 -Ref: #how-csv-rules-are-evaluated301408 -Node: TIMECLOCK FORMAT302859 -Ref: #timeclock-format302999 -Node: TIMEDOT FORMAT305060 -Ref: #timedot-format305198 -Node: COMMON TASKS309760 -Ref: #common-tasks309889 -Node: Getting help310296 -Ref: #getting-help310430 -Node: Constructing command lines310983 -Ref: #constructing-command-lines311177 -Node: Starting a journal file311874 -Ref: #starting-a-journal-file312074 -Node: Setting opening balances313262 -Ref: #setting-opening-balances313460 -Node: Recording transactions316601 -Ref: #recording-transactions316783 -Node: Reconciling317339 -Ref: #reconciling317484 -Node: Reporting319741 -Ref: #reporting319883 -Node: Migrating to a new file323882 -Ref: #migrating-to-a-new-file324032 -Node: LIMITATIONS324331 -Ref: #limitations324459 -Node: TROUBLESHOOTING325202 -Ref: #troubleshooting325317 +Node: Sorting by amount99484 +Ref: #sorting-by-amount99639 +Node: Percentages100309 +Ref: #percentages100467 +Node: Balance change end balance101428 +Ref: #balance-change-end-balance101621 +Node: Balance report types103049 +Ref: #balance-report-types103239 +Node: Useful balance reports107518 +Ref: #useful-balance-reports107699 +Node: Budget report108784 +Ref: #budget-report108968 +Node: Budget report start date114243 +Ref: #budget-report-start-date114421 +Node: Budgets and subaccounts115753 +Ref: #budgets-and-subaccounts115960 +Node: Selecting budget goals119400 +Ref: #selecting-budget-goals119572 +Node: Customising single-period balance reports120606 +Ref: #customising-single-period-balance-reports120815 +Node: balancesheet122990 +Ref: #balancesheet123128 +Node: balancesheetequity124427 +Ref: #balancesheetequity124578 +Node: cashflow125958 +Ref: #cashflow126082 +Node: check127228 +Ref: #check127333 +Node: Basic checks127967 +Ref: #basic-checks128085 +Node: Strict checks128636 +Ref: #strict-checks128777 +Node: Other checks129213 +Ref: #other-checks129353 +Node: Custom checks129710 +Ref: #custom-checks129830 +Node: close130247 +Ref: #close130351 +Node: close and prices132442 +Ref: #close-and-prices132571 +Node: close date132966 +Ref: #close-date133150 +Node: Example close asset/liability accounts for file transition133907 +Ref: #example-close-assetliability-accounts-for-file-transition134208 +Node: Hiding opening/closing transactions135067 +Ref: #hiding-openingclosing-transactions135338 +Node: close and balance assertions136715 +Ref: #close-and-balance-assertions136973 +Node: Example close revenue/expense accounts to retained earnings138327 +Ref: #example-close-revenueexpense-accounts-to-retained-earnings138605 +Node: codes139495 +Ref: #codes139605 +Node: commodities140317 +Ref: #commodities140446 +Node: descriptions140528 +Ref: #descriptions140658 +Node: diff140962 +Ref: #diff141070 +Node: files142117 +Ref: #files142219 +Node: help142366 +Ref: #help142468 +Node: import143286 +Ref: #import143402 +Node: Deduplication144267 +Ref: #deduplication144392 +Node: Import testing146286 +Ref: #import-testing146451 +Node: Importing balance assignments146939 +Ref: #importing-balance-assignments147145 +Node: Commodity display styles147794 +Ref: #commodity-display-styles147967 +Node: incomestatement148096 +Ref: #incomestatement148231 +Node: notes149536 +Ref: #notes149651 +Node: payees150019 +Ref: #payees150127 +Node: prices150653 +Ref: #prices150761 +Node: print151130 +Ref: #print151242 +Node: print-unique156557 +Ref: #print-unique156685 +Node: register156970 +Ref: #register157099 +Node: Custom register output161545 +Ref: #custom-register-output161676 +Node: register-match163013 +Ref: #register-match163149 +Node: rewrite163500 +Ref: #rewrite163617 +Node: Re-write rules in a file165523 +Ref: #re-write-rules-in-a-file165686 +Node: Diff output format166835 +Ref: #diff-output-format167018 +Node: rewrite vs print --auto168110 +Ref: #rewrite-vs.-print---auto168270 +Node: roi168826 +Ref: #roi168926 +Node: Spaces and special characters in --inv and --pnl170612 +Ref: #spaces-and-special-characters-in---inv-and---pnl170852 +Node: Semantics of --inv and --pnl171340 +Ref: #semantics-of---inv-and---pnl171579 +Node: IRR and TWR explained173429 +Ref: #irr-and-twr-explained173589 +Node: stats176657 +Ref: #stats176758 +Node: tags178138 +Ref: #tags178238 +Node: test178757 +Ref: #test178873 +Node: About add-on commands179620 +Ref: #about-add-on-commands179757 +Node: JOURNAL FORMAT180888 +Ref: #journal-format181016 +Node: Transactions183243 +Ref: #transactions183358 +Node: Dates184372 +Ref: #dates184488 +Node: Simple dates184553 +Ref: #simple-dates184673 +Node: Secondary dates185182 +Ref: #secondary-dates185330 +Node: Posting dates186666 +Ref: #posting-dates186789 +Node: Status188161 +Ref: #status188271 +Node: Code189979 +Ref: #code190091 +Node: Description190323 +Ref: #description190451 +Node: Payee and note190771 +Ref: #payee-and-note190879 +Node: Comments191214 +Ref: #comments191336 +Node: Tags192530 +Ref: #tags-1192641 +Node: Postings194034 +Ref: #postings194158 +Node: Virtual postings195184 +Ref: #virtual-postings195295 +Node: Account names196600 +Ref: #account-names196737 +Node: Amounts197225 +Ref: #amounts197362 +Node: Decimal marks digit group marks198347 +Ref: #decimal-marks-digit-group-marks198524 +Node: Commodity199545 +Ref: #commodity199734 +Node: Directives influencing number parsing and display200686 +Ref: #directives-influencing-number-parsing-and-display200947 +Node: Commodity display style201440 +Ref: #commodity-display-style201648 +Node: Rounding203843 +Ref: #rounding203963 +Node: Transaction prices204375 +Ref: #transaction-prices204541 +Node: Lot prices lot dates206972 +Ref: #lot-prices-lot-dates207155 +Node: Balance assertions207643 +Ref: #balance-assertions207821 +Node: Assertions and ordering208854 +Ref: #assertions-and-ordering209036 +Node: Assertions and included files209736 +Ref: #assertions-and-included-files209973 +Node: Assertions and multiple -f options210306 +Ref: #assertions-and-multiple--f-options210556 +Node: Assertions and commodities210688 +Ref: #assertions-and-commodities210914 +Node: Assertions and prices212071 +Ref: #assertions-and-prices212279 +Node: Assertions and subaccounts212719 +Ref: #assertions-and-subaccounts212942 +Node: Assertions and virtual postings213266 +Ref: #assertions-and-virtual-postings213502 +Node: Assertions and precision213644 +Ref: #assertions-and-precision213831 +Node: Balance assignments214098 +Ref: #balance-assignments214268 +Node: Balance assignments and prices215432 +Ref: #balance-assignments-and-prices215598 +Node: Directives215822 +Ref: #directives215985 +Node: Directives and multiple files220477 +Ref: #directives-and-multiple-files220673 +Node: Comment blocks221365 +Ref: #comment-blocks221542 +Node: Including other files221718 +Ref: #including-other-files221892 +Node: Default year222816 +Ref: #default-year222974 +Node: Declaring payees223381 +Ref: #declaring-payees223552 +Node: Declaring the decimal mark223798 +Ref: #declaring-the-decimal-mark223998 +Node: Declaring commodities224395 +Ref: #declaring-commodities224586 +Node: Commodity error checking227104 +Ref: #commodity-error-checking227254 +Node: Default commodity227511 +Ref: #default-commodity227691 +Node: Declaring market prices228807 +Ref: #declaring-market-prices228996 +Node: Declaring accounts229809 +Ref: #declaring-accounts229989 +Node: Account error checking231191 +Ref: #account-error-checking231357 +Node: Account comments232536 +Ref: #account-comments232720 +Node: Account subdirectives233144 +Ref: #account-subdirectives233329 +Node: Account types233642 +Ref: #account-types233816 +Node: Auto-detected account types235139 +Ref: #auto-detected-account-types235294 +Node: Account display order236529 +Ref: #account-display-order236689 +Node: Rewriting accounts237840 +Ref: #rewriting-accounts238019 +Node: Basic aliases238776 +Ref: #basic-aliases238912 +Node: Regex aliases239656 +Ref: #regex-aliases239818 +Node: Combining aliases240537 +Ref: #combining-aliases240720 +Node: Aliases and multiple files241996 +Ref: #aliases-and-multiple-files242195 +Node: end aliases242774 +Ref: #end-aliases242921 +Node: Default parent account243070 +Ref: #default-parent-account243260 +Node: Periodic transactions244144 +Ref: #periodic-transactions244327 +Node: Periodic rule syntax246244 +Ref: #periodic-rule-syntax246444 +Node: Two spaces between period expression and description!247148 +Ref: #two-spaces-between-period-expression-and-description247461 +Node: Forecasting with periodic transactions248145 +Ref: #forecasting-with-periodic-transactions248444 +Node: Budgeting with periodic transactions251215 +Ref: #budgeting-with-periodic-transactions251448 +Node: Auto postings251857 +Ref: #auto-postings251993 +Node: Auto postings and multiple files254172 +Ref: #auto-postings-and-multiple-files254370 +Node: Auto postings and dates254579 +Ref: #auto-postings-and-dates254847 +Node: Auto postings and transaction balancing / inferred amounts / balance assertions255022 +Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions255367 +Node: Auto posting tags255870 +Ref: #auto-posting-tags256079 +Node: CSV FORMAT256715 +Ref: #csv-format256843 +Node: Examples259472 +Ref: #examples259575 +Node: Basic259783 +Ref: #basic259885 +Node: Bank of Ireland260427 +Ref: #bank-of-ireland260564 +Node: Amazon262026 +Ref: #amazon262146 +Node: Paypal263865 +Ref: #paypal263961 +Node: CSV rules271605 +Ref: #csv-rules271723 +Node: skip272056 +Ref: #skip272156 +Node: fields list272531 +Ref: #fields-list272670 +Node: field assignment274173 +Ref: #field-assignment274325 +Node: Field names275360 +Ref: #field-names275500 +Node: date field275880 +Ref: #date-field276000 +Node: date2 field276048 +Ref: #date2-field276191 +Node: status field276247 +Ref: #status-field276392 +Node: code field276441 +Ref: #code-field276588 +Node: description field276633 +Ref: #description-field276795 +Node: comment field276854 +Ref: #comment-field277011 +Node: account field277311 +Ref: #account-field277463 +Node: amount field278038 +Ref: #amount-field278189 +Node: currency field279434 +Ref: #currency-field279589 +Node: balance field279846 +Ref: #balance-field279980 +Node: separator280352 +Ref: #separator280484 +Node: if block281024 +Ref: #if-block281151 +Node: Matching the whole record281552 +Ref: #matching-the-whole-record281729 +Node: Matching individual fields282532 +Ref: #matching-individual-fields282738 +Node: Combining matchers282962 +Ref: #combining-matchers283160 +Node: Rules applied on successful match283473 +Ref: #rules-applied-on-successful-match283666 +Node: if table284320 +Ref: #if-table284441 +Node: end286179 +Ref: #end286293 +Node: date-format286517 +Ref: #date-format286651 +Node: decimal-mark287647 +Ref: #decimal-mark287794 +Node: newest-first288133 +Ref: #newest-first288276 +Node: include288959 +Ref: #include289092 +Node: balance-type289536 +Ref: #balance-type289658 +Node: Tips290358 +Ref: #tips290449 +Node: Rapid feedback290748 +Ref: #rapid-feedback290867 +Node: Valid CSV291319 +Ref: #valid-csv291451 +Node: File Extension291643 +Ref: #file-extension291797 +Node: Reading multiple CSV files292226 +Ref: #reading-multiple-csv-files292413 +Node: Valid transactions292654 +Ref: #valid-transactions292834 +Node: Deduplicating importing293462 +Ref: #deduplicating-importing293643 +Node: Setting amounts294676 +Ref: #setting-amounts294833 +Node: Amount signs297274 +Ref: #amount-signs297428 +Node: Setting currency/commodity298115 +Ref: #setting-currencycommodity298303 +Node: Amount decimal places299477 +Ref: #amount-decimal-places299669 +Node: Referencing other fields299981 +Ref: #referencing-other-fields300180 +Node: How CSV rules are evaluated301077 +Ref: #how-csv-rules-are-evaluated301252 +Node: TIMECLOCK FORMAT302703 +Ref: #timeclock-format302843 +Node: TIMEDOT FORMAT304904 +Ref: #timedot-format305042 +Node: COMMON TASKS309604 +Ref: #common-tasks309733 +Node: Getting help310140 +Ref: #getting-help310274 +Node: Constructing command lines310827 +Ref: #constructing-command-lines311021 +Node: Starting a journal file311718 +Ref: #starting-a-journal-file311918 +Node: Setting opening balances313106 +Ref: #setting-opening-balances313304 +Node: Recording transactions316445 +Ref: #recording-transactions316627 +Node: Reconciling317183 +Ref: #reconciling317328 +Node: Reporting319585 +Ref: #reporting319727 +Node: Migrating to a new file323726 +Ref: #migrating-to-a-new-file323876 +Node: LIMITATIONS324175 +Ref: #limitations324303 +Node: TROUBLESHOOTING325046 +Ref: #troubleshooting325161  End Tag Table diff --git a/hledger/hledger.txt b/hledger/hledger.txt index 466cc019a..2ec1a2e18 100644 --- a/hledger/hledger.txt +++ b/hledger/hledger.txt @@ -2212,12 +2212,12 @@ COMMANDS bols in a separate column o --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). + value. We currently support this with CSV output only. In tidy + mode, totals and row averages are disabled (-N/--no-total is implied + and -T/--row-total and -A/--average will be ignored). - These --layout values affect some but not all of the output formats, as - shown: + These --layout modes are supported with some but not all of the output + formats: @@ -2312,41 +2312,26 @@ COMMANDS o Tidy layout produces normalised "tidy data", where every variable is a column and each row represents a single data point (see https://cran.r-project.org/web/packages/tidyr/vignettes/tidy- - data.html). This is the form of data most easily processed by other - software. Currently we support it with the CSV output format only: + data.html). This kind of data is the easiest to process with other + software: - $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=tidy -Y - "account","date","commodity","value" - "Assets:US:ETrade","2012","GLD","0" - "Assets:US:ETrade","2012","ITOT","10.00" - "Assets:US:ETrade","2012","USD","337.18" - "Assets:US:ETrade","2012","VEA","12.00" - "Assets:US:ETrade","2012","VHT","106.00" - "Assets:US:ETrade","2013","GLD","70.00" - "Assets:US:ETrade","2013","ITOT","18.00" - "Assets:US:ETrade","2013","USD","-98.12" - "Assets:US:ETrade","2013","VEA","10.00" - "Assets:US:ETrade","2013","VHT","18.00" - "Assets:US:ETrade","2014","GLD","0" - "Assets:US:ETrade","2014","ITOT","-11.00" - "Assets:US:ETrade","2014","USD","4881.44" - "Assets:US:ETrade","2014","VEA","14.00" - "Assets:US:ETrade","2014","VHT","170.00" - "total","2012","GLD","0" - "total","2012","ITOT","10.00" - "total","2012","USD","337.18" - "total","2012","VEA","12.00" - "total","2012","VHT","106.00" - "total","2013","GLD","70.00" - "total","2013","ITOT","18.00" - "total","2013","USD","-98.12" - "total","2013","VEA","10.00" - "total","2013","VHT","18.00" - "total","2014","GLD","0" - "total","2014","ITOT","-11.00" - "total","2014","USD","4881.44" - "total","2014","VEA","14.00" - "total","2014","VHT","170.00" + $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -Y -O csv --layout=tidy + "account","period","start_date","end_date","commodity","value" + "Assets:US:ETrade","2012","2012-01-01","2012-12-31","GLD","0" + "Assets:US:ETrade","2012","2012-01-01","2012-12-31","ITOT","10.00" + "Assets:US:ETrade","2012","2012-01-01","2012-12-31","USD","337.18" + "Assets:US:ETrade","2012","2012-01-01","2012-12-31","VEA","12.00" + "Assets:US:ETrade","2012","2012-01-01","2012-12-31","VHT","106.00" + "Assets:US:ETrade","2013","2013-01-01","2013-12-31","GLD","70.00" + "Assets:US:ETrade","2013","2013-01-01","2013-12-31","ITOT","18.00" + "Assets:US:ETrade","2013","2013-01-01","2013-12-31","USD","-98.12" + "Assets:US:ETrade","2013","2013-01-01","2013-12-31","VEA","10.00" + "Assets:US:ETrade","2013","2013-01-01","2013-12-31","VHT","18.00" + "Assets:US:ETrade","2014","2014-01-01","2014-12-31","GLD","0" + "Assets:US:ETrade","2014","2014-01-01","2014-12-31","ITOT","-11.00" + "Assets:US:ETrade","2014","2014-01-01","2014-12-31","USD","4881.44" + "Assets:US:ETrade","2014","2014-01-01","2014-12-31","VEA","14.00" + "Assets:US:ETrade","2014","2014-01-01","2014-12-31","VHT","170.00" Sorting by amount With -S/--sort-amount, accounts with the largest (most positive) bal- @@ -5014,8 +4999,6 @@ JOURNAL FORMAT account. comment Ignores part of the journal file, until end of current file Y or end comment. - - commod- Declares a commodity, for checking all entries in all files; N, Y ity the decimal mark for parsing amounts of this commodity, for following entries until end of current file; and its display @@ -5899,6 +5882,7 @@ CSV FORMAT records fields list name CSV fields, assign them to hledger fields + field assignment assign a value to one hledger field, with interpolation Field names hledger field names, used in the fields list