ViewInfo: Print out reference financial info

Description Usage Arguments Details Value

Description

Grabs information from the ledger.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
viewAssets(ledger = viewLedger(file = file), file = viewLedgerFile(),
  from = as.Date("1900-01-01"), to = componentsToDate(),
  suppress = TRUE)

viewBudgets(suppress = FALSE)

viewBudgetCategoriesAll(suppress = TRUE)

viewBudgetCategoriesSpendingSmall(suppress = TRUE)

viewBudgetCategoriesSpending(suppress = TRUE)

viewBudgetCategoriesReal(suppress = TRUE)

viewAccountCategories(ledger = viewLedger(file = file),
  file = viewLedgerFile(), accounts = NULL, formal = FALSE,
  suppress = TRUE)

Arguments

ledger

Data frame ledger. The ledger where each row is a transaction and with columns for year, month, day, description, budget, and one column for each financial account. All columns should be numeric except for description and budget.

file

The path for the ledger for loading and saving. Has an underlying default that needs to be changed in the ViewLedger file.

from

Boundaries on the ledger dates. Requires Date class.

to

Boundaries on the ledger dates. Requires Date class.

suppress

Prevents it from printing to the console. All low-level functions default to TRUE, while high-level functions that do not have callers and exist for the sole purpose of printing out information default to FALSE.

Details

viewAssets simply prints the current values for each account by summing the values of each account.
viewBudgets returns the budget categories and their allowed amounts per month.
viewBudgetCategories grabs the levels of the factor column budget.category, while viewBudgetCategoriesReal ignores the categories without explicit budget levels, like discretionary spending, and viewBudgetCategoriesSpending is the same, but also discards expected income, and viewBudgetCategoriesSpendingSmall elminiates categories with spending outside one standard deviation of all the budgeted amounts.
viewAccountCategories provides the factor names from the ledger that correspond to the account categories.

Value

Character vector.


egaffincahn/finances documentation built on Nov. 13, 2018, 7:05 a.m.