Skip to contents

Summary of gains and losses

Source: R/report_summary.R
report_summary.Rd

Provides a summary of realized capital gains and losses (and total).

Usage

report_summary(
  formatted.ACB,
  today.data = TRUE,
  tax.year = "all",
  local.timezone = Sys.timezone(),
  list.prices = NULL,
  slug = NULL,
  start.date = NULL,
  force = FALSE
)

Arguments

formatted.ACB

The formatted ACB data.

today.data

whether to fetch today's data.

tax.year

Which tax year(s) to include.

local.timezone

Which time zone to use for the date of the report.

list.prices

A list.prices object from which to fetch coin prices. For today.data = TRUE, it must contain at least currency, spot.rate2, and date2.

slug

Optional explicit slug vector used when preparing prices.

start.date

Optional explicit start date used when preparing prices.

force

Whether to force recreating list.prices even though it already exists (e.g., if you added new coins or new dates).

Value

A summary data frame, containing at least the following columns: Type, Amount, currency.

Examples

all.data <- format_exchanges(data_shakepay)
#> Exchange detected: shakepay
formatted.ACB <- format_ACB(all.data, verbose = FALSE)
report_summary(formatted.ACB, today.data = FALSE)
#>                  Type Amount currency
#>              tax.year    all      CAD
#> gains           gains   5.81      CAD
#> losses         losses   0.00      CAD
#> net               net   5.81      CAD
#> total.cost total.cost  27.62      CAD
#> revenue       revenue   3.64      CAD