Skip to content

Commit

Permalink
chore: Tweak URLs [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
@trevorld
trevorld committed Nov 12, 2021
1 parent a2346fb commit bb4f377
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 62 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Version: 2.0.9
Authors@R: c(person("Trevor L", "Davis", role = c("aut", "cre"), email="[email protected]"),
person("Jenya", "Sovetkin", role="ctb"),
person("Chris", "Lloyd", role="ctb"))
URL: https://github.com/trevorld/r-ledger, https://trevorldavis.com/R/ledger
URL: https://github.com/trevorld/r-ledger, https://trevorldavis.com/R/ledger/
BugReports: https://github.com/trevorld/r-ledger/issues
Description: Utilities for querying plain text accounting files from 'Ledger', 'HLedger', and 'Beancount'.
Imports:
Expand Down
6 changes: 3 additions & 3 deletions README.Rrst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ knitr::opts_chunk$set(fig.path = "man/figures/README-")
:target: https://cran.r-project.org/package=ledger
:alt: RStudio CRAN mirror downloads

``ledger`` is an R package to import data from `plain text accounting <https://plaintextaccounting.org/>`_ software like `Ledger <https://www.ledger-cli.org/>`_, `HLedger <http://hledger.org/>`_, and `Beancount <http://furius.ca/beancount/>`_ into an R data frame for convenient analysis, plotting, and export.
``ledger`` is an R package to import data from `plain text accounting <https://plaintextaccounting.org/>`_ software like `Ledger <https://www.ledger-cli.org/>`_, `HLedger <https://hledger.org/>`_, and `Beancount <https://github.com/beancount/beancount>`_ into an R data frame for convenient analysis, plotting, and export.

Right now it supports reading in the register from ``ledger``, ``hledger``, and ``beancount`` files.

Expand Down Expand Up @@ -49,10 +49,10 @@ ledger
`ledger <https://www.ledger-cli.org/>`_ (>= 3.1)

hledger
`hledger <http://hledger.org/>`_ (>= 1.4)
`hledger <https://hledger.org/>`_ (>= 1.4)

beancount
`beancount <http://furius.ca/beancount/>`_ (>= 2.0)
`beancount <https://github.com/beancount/beancount>`_ (>= 2.0)

To install hledger run the following in your shell:

Expand Down
115 changes: 57 additions & 58 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ ledger
:target: https://cran.r-project.org/package=ledger
:alt: RStudio CRAN mirror downloads

``ledger`` is an R package to import data from `plain text accounting <https://plaintextaccounting.org/>`_ software like `Ledger <https://www.ledger-cli.org/>`_, `HLedger <http://hledger.org/>`_, and `Beancount <http://furius.ca/beancount/>`_ into an R data frame for convenient analysis, plotting, and export.
``ledger`` is an R package to import data from `plain text accounting <https://plaintextaccounting.org/>`_ software like `Ledger <https://www.ledger-cli.org/>`_, `HLedger <https://hledger.org/>`_, and `Beancount <https://github.com/beancount/beancount>`_ into an R data frame for convenient analysis, plotting, and export.

Right now it supports reading in the register from ``ledger``, ``hledger``, and ``beancount`` files.

Expand Down Expand Up @@ -47,10 +47,10 @@ ledger
`ledger <https://www.ledger-cli.org/>`_ (>= 3.1)

hledger
`hledger <http://hledger.org/>`_ (>= 1.4)
`hledger <https://hledger.org/>`_ (>= 1.4)

beancount
`beancount <http://furius.ca/beancount/>`_ (>= 2.0)
`beancount <https://github.com/beancount/beancount>`_ (>= 2.0)

To install hledger run the following in your shell:

Expand Down Expand Up @@ -175,11 +175,11 @@ Here is an example reading in a beancount file generated by ``bean-example``:

::

## # A tibble: 3,468 × 12
## # A tibble: 3,330 × 12
## date mark payee description account amount commodity historical_cost hc_commodity market_value mv_commodity tags
## <chr> <chr> <chr> <chr> <chr> <dbl> <chr> <dbl> <chr> <dbl> <chr> <chr>
## 1 2019-01-01 * "" Opening Balance for checking account Assets:US:BofA:Checking 3402. USD 3402. USD 3402. USD ""
## 2 2019-01-01 * "" Opening Balance for checking account Equity:Opening-Balances -3402. USD -3402. USD -3402. USD ""
## 1 2019-01-01 * "" Opening Balance for checking account Assets:US:BofA:Checking 4119. USD 4119. USD 4119. USD ""
## 2 2019-01-01 * "" Opening Balance for checking account Equity:Opening-Balances -4119. USD -4119. USD -4119. USD ""
## 3 2019-01-01 * "" Allowed contributions for one year Income:US:Federal:PreTax401k -18500 IRAUSD -18500 IRAUSD -18500 IRAUSD ""
## 4 2019-01-01 * "" Allowed contributions for one year Assets:US:Federal:PreTax401k 18500 IRAUSD 18500 IRAUSD 18500 IRAUSD ""
## 5 2019-01-03 * "Hooli" Payroll Assets:US:BofA:Checking 1351. USD 1351. USD 1351. USD ""
Expand All @@ -188,7 +188,7 @@ Here is an example reading in a beancount file generated by ``bean-example``:
## 8 2019-01-03 * "Hooli" Payroll Income:US:Hooli:GroupTermLife -24.3 USD -24.3 USD -24.3 USD ""
## 9 2019-01-03 * "Hooli" Payroll Expenses:Health:Life:GroupTermLife 24.3 USD 24.3 USD 24.3 USD ""
## 10 2019-01-03 * "Hooli" Payroll Expenses:Health:Dental:Insurance 2.9 USD 2.9 USD 2.9 USD ""
## # … with 3,458 more rows
## # … with 3,320 more rows


.. sourcecode:: r
Expand All @@ -212,13 +212,13 @@ Here is an example reading in a beancount file generated by ``bean-example``:
## # Groups: trip [3]
## trip account trip_total
## <chr> <chr> <dbl>
## 1 trip-los-angeles-2021 Expenses:Food:Alcohol 97.7
## 2 trip-los-angeles-2021 Expenses:Food:Coffee 59.0
## 3 trip-los-angeles-2021 Expenses:Food:Restaurant 1019.
## 4 trip-new-york-2019 Expenses:Food:Coffee 9.63
## 5 trip-new-york-2019 Expenses:Food:Restaurant 438.
## 6 trip-san-francisco-2020 Expenses:Food:Coffee 39.1
## 7 trip-san-francisco-2020 Expenses:Food:Restaurant 659.
## 1 trip-boston-2020 Expenses:Food:Coffee 6.39
## 2 trip-boston-2020 Expenses:Food:Restaurant 234.
## 3 trip-los-angeles-2021 Expenses:Food:Alcohol 52.6
## 4 trip-los-angeles-2021 Expenses:Food:Coffee 24.3
## 5 trip-los-angeles-2021 Expenses:Food:Restaurant 458.
## 6 trip-san-francisco-2019 Expenses:Food:Coffee 30.0
## 7 trip-san-francisco-2019 Expenses:Food:Restaurant 624.



Expand Down Expand Up @@ -338,16 +338,16 @@ Some examples using the ``prune_coa`` function to simplify the "Chart of Account
## account mv_commodity market_value
## <chr> <chr> <dbl>
## 1 Assets IRAUSD 0
## 2 Assets USD 113070.
## 3 Assets VACHR -25
## 4 Equity USD -3402.
## 2 Assets USD 119287.
## 3 Assets VACHR 87
## 4 Equity USD -4119.
## 5 Expenses IRAUSD 55500
## 6 Expenses USD 270092.
## 7 Expenses VACHR 400
## 6 Expenses USD 269081.
## 7 Expenses VACHR 288
## 8 Income IRAUSD -55500
## 9 Income USD -377742.
## 9 Income USD -377046.
## 10 Income VACHR -375
## 11 Liabilities USD -2817.
## 11 Liabilities USD -2248.


.. sourcecode:: r
Expand All @@ -364,22 +364,22 @@ Some examples using the ``prune_coa`` function to simplify the "Chart of Account
## account mv_commodity market_value
## <chr> <chr> <dbl>
## 1 Assets:US IRAUSD 0
## 2 Assets:US USD 1.13e+ 5
## 3 Assets:US VACHR -2.5 e+ 1
## 4 Equity:Opening-Balances USD -3.40e+ 3
## 5 Expenses:Financial USD 5.25e+ 2
## 6 Expenses:Food USD 1.97e+ 4
## 2 Assets:US USD 1.19e+ 5
## 3 Assets:US VACHR 8.7 e+ 1
## 4 Equity:Opening-Balances USD -4.12e+ 3
## 5 Expenses:Financial USD 4.44e+ 2
## 6 Expenses:Food USD 1.87e+ 4
## 7 Expenses:Health USD 7.27e+ 3
## 8 Expenses:Home USD 8.87e+ 4
## 8 Expenses:Home USD 8.86e+ 4
## 9 Expenses:Taxes IRAUSD 5.55e+ 4
## 10 Expenses:Taxes USD 1.50e+ 5
## 11 Expenses:Transport USD 4.08e+ 3
## 12 Expenses:Vacation VACHR 4 e+ 2
## 12 Expenses:Vacation VACHR 2.88e+ 2
## 13 Income:US IRAUSD -5.55e+ 4
## 14 Income:US USD -3.78e+ 5
## 14 Income:US USD -3.77e+ 5
## 15 Income:US VACHR -3.75e+ 2
## 16 Liabilities:AccountsPayable USD -1.14e-13
## 17 Liabilities:US USD -2.82e+ 3
## 16 Liabilities:AccountsPayable USD 5.68e-14
## 17 Liabilities:US USD -2.25e+ 3


Expand Down Expand Up @@ -460,8 +460,8 @@ Here is some basic balance sheets (using the market value of our assets):
## date commodity net_worth assets liabilities
## <date> <chr> <dbl> <dbl> <dbl>
## 1 2021-11-12 IRAUSD 0 0 0
## 2 2021-11-12 USD 118837. 121158. -2321.
## 3 2021-11-12 VACHR 63 63 0
## 2 2021-11-12 USD 123655. 126076. -2421.
## 3 2021-11-12 VACHR 15 15 0


.. sourcecode:: r
Expand All @@ -475,11 +475,11 @@ Here is some basic balance sheets (using the market value of our assets):
## # A tibble: 1 × 3
## account mv_commodity market_value
## <chr> <chr> <dbl>
## 1 Assets:US USD 4646.
## 1 Assets:US USD 6785.
## # A tibble: 1 × 3
## account mv_commodity market_value
## <chr> <chr> <dbl>
## 1 Liabilities:US USD -2321.
## 1 Liabilities:US USD -2421.


.. sourcecode:: r
Expand All @@ -493,13 +493,13 @@ Here is some basic balance sheets (using the market value of our assets):
## # A tibble: 3 × 3
## account mv_commodity market_value
## <chr> <chr> <dbl>
## 1 Assets:US:BofA:Checking USD 3188.
## 2 Assets:US:ETrade:Cash USD 1458.
## 3 Assets:US:Vanguard:Cash USD 0.0100
## 1 Assets:US:ETrade:Cash USD 6297.
## 2 Assets:US:BofA:Checking USD 489.
## 3 Assets:US:Vanguard:Cash USD -0.0200
## # A tibble: 1 × 3
## account mv_commodity market_value
## <chr> <chr> <dbl>
## 1 Liabilities:US:Chase:Slate USD -2321.
## 1 Liabilities:US:Chase:Slate USD -2421.



Expand Down Expand Up @@ -578,9 +578,9 @@ Basic income sheets
## # A tibble: 3 × 5
## commodity type `Sep 2021` `Oct 2021` `Nov 2021`
## <chr> <chr> <dbl> <dbl> <dbl>
## 1 USD expenses 7357. 7567. 2281.
## 2 USD income 9538. 9258. 4640.
## 3 USD net 2181. 1691. 2359.
## 1 USD expenses 7408. 7453. 2227.
## 2 USD income 9437. 9279. 4640.
## 3 USD net 2028. 1826. 2413.


.. sourcecode:: r
Expand All @@ -594,7 +594,7 @@ Basic income sheets
## # A tibble: 1 × 5
## account commodity `Sep 2021` `Oct 2021` `Nov 2021`
## <chr> <chr> <dbl> <dbl> <dbl>
## 1 Income:US USD 9538. 9258. 4640.
## 1 Income:US USD 9437. 9279. 4640.


.. sourcecode:: r
Expand All @@ -608,10 +608,10 @@ Basic income sheets
## # A tibble: 6 × 5
## account commodity `Sep 2021` `Oct 2021` `Nov 2021`
## <chr> <chr> <dbl> <dbl> <dbl>
## 1 Expenses:Financial USD 4 57.7 4
## 2 Expenses:Food USD 479. 602. 188.
## 1 Expenses:Financial USD 4 39.8 4
## 2 Expenses:Food USD 504. 502. 134.
## 3 Expenses:Health USD 194. 194. 96.9
## 4 Expenses:Home USD 2576. 2609. 0
## 4 Expenses:Home USD 2602. 2614. 0
## 5 Expenses:Taxes USD 3984. 3984. 1992.
## 6 Expenses:Transport USD 120 120 0

Expand All @@ -624,13 +624,12 @@ Basic income sheets

::

## # A tibble: 4 × 5
## account commodity `Sep 2021` `Oct 2021` `Nov 2021`
## <chr> <chr> <dbl> <dbl> <dbl>
## 1 Income:US:BayBook:GroupTermLife USD 48.6 48.6 24.3
## 2 Income:US:BayBook:Salary USD 9231. 9231. 4615.
## 3 Income:US:ETrade:ITOT:Dividend USD 258. 0 0
## 4 Income:US:ETrade:PnL USD 0 -21.8 0
## # A tibble: 3 × 5
## account commodity `Sep 2021` `Oct 2021` `Nov 2021`
## <chr> <chr> <dbl> <dbl> <dbl>
## 1 Income:US:ETrade:GLD:Dividend USD 157. 0 0
## 2 Income:US:Hoogle:GroupTermLife USD 48.6 48.6 24.3
## 3 Income:US:Hoogle:Salary USD 9231. 9231. 4615.


.. sourcecode:: r
Expand All @@ -644,17 +643,17 @@ Basic income sheets
## # A tibble: 19 × 5
## account commodity `Sep 2021` `Oct 2021` `Nov 2021`
## <chr> <chr> <dbl> <dbl> <dbl>
## 1 Expenses:Financial:Commissions USD 0 53.7 0
## 1 Expenses:Financial:Commissions USD 0 35.8 0
## 2 Expenses:Financial:Fees USD 4 4 4
## 3 Expenses:Food:Groceries USD 158. 228. 84.7
## 4 Expenses:Food:Restaurant USD 321. 374. 103.
## 3 Expenses:Food:Groceries USD 249. 230. 68.5
## 4 Expenses:Food:Restaurant USD 256. 272. 65.2
## 5 Expenses:Health:Dental:Insurance USD 5.8 5.8 2.9
## 6 Expenses:Health:Life:GroupTermLife USD 48.6 48.6 24.3
## 7 Expenses:Health:Medical:Insurance USD 54.8 54.8 27.4
## 8 Expenses:Health:Vision:Insurance USD 84.6 84.6 42.3
## 9 Expenses:Home:Electricity USD 65 65 0
## 10 Expenses:Home:Internet USD 80.0 80.0 0
## 11 Expenses:Home:Phone USD 30.8 64.3 0
## 10 Expenses:Home:Internet USD 80.0 79.9 0
## 11 Expenses:Home:Phone USD 56.8 68.6 0
## 12 Expenses:Home:Rent USD 2400 2400 0
## 13 Expenses:Taxes:Y2021:US:CityNYC USD 350. 350. 175.
## 14 Expenses:Taxes:Y2021:US:Federal USD 2126. 2126. 1063.
Expand Down
Binary file modified man/figures/README-income_chart-1.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-net_worth_chart-1.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bb4f377

Please sign in to comment.