Hledger.Reports.ReportTypes

New common report types, used by the BudgetReport for now, perhaps all reports later.

Documentation

data PeriodicReport a b

A periodic report is a generic tabular report, where each row corresponds to some label (usually an account name) and each column to a date period. The column periods are usually consecutive subperiods formed by splitting the overall report period by some report interval (daily, weekly, etc.). It has:

1. a list of each column's period (date span)
2. a list of rows, each containing:

• an account label
• the account's depth
• A list of amounts, one for each column. Depending on the value type, these can represent balance changes, ending balances, budget performance, etc. (for example, see BalanceType and Hledger.Cli.Commands.Balance).
• the total of the row's amounts for a periodic report, or zero for cumulative/historical reports (since summing end balances generally doesn't make sense).
• the average of the row's amounts

1. the column totals, and the overall grand total (or zero for cumulative/historical reports) and grand average.

Constructors

PeriodicReport

Fields

• prDates :: [DateSpan]
• prRows :: [PeriodicReportRow a b]
• prTotals :: PeriodicReportRow () b

Instances

Functor (PeriodicReport a)

Defined in Hledger.Reports.ReportTypes

Methods

fmap :: (a0 -> b) -> PeriodicReport a a0 -> PeriodicReport a b

(<$) :: a0 -> PeriodicReport a b -> PeriodicReport a a0

(Show a, Show b) => Show (PeriodicReport a b)

Defined in Hledger.Reports.ReportTypes

Methods

showsPrec :: Int -> PeriodicReport a b -> ShowS

show :: PeriodicReport a b -> String

showList :: [PeriodicReport a b] -> ShowS

Generic (PeriodicReport a b)

Defined in Hledger.Reports.ReportTypes

Associated Types

type Rep (PeriodicReport a b) :: Type -> Type

Methods

from :: PeriodicReport a b -> Rep (PeriodicReport a b) x

to :: Rep (PeriodicReport a b) x -> PeriodicReport a b

(ToJSON a, ToJSON b) => ToJSON (PeriodicReport a b)

Defined in Hledger.Reports.ReportTypes

Methods

toJSON :: PeriodicReport a b -> Value

toEncoding :: PeriodicReport a b -> Encoding

toJSONList :: [PeriodicReport a b] -> Value

toEncodingList :: [PeriodicReport a b] -> Encoding

type Rep (PeriodicReport a b)

Defined in Hledger.Reports.ReportTypes

type Rep (PeriodicReport a b) = D1 ('MetaData "PeriodicReport" "Hledger.Reports.ReportTypes" "hledger-lib-1.21-9YdjUnmp5UyCwNfm42kb7l" 'False) (C1 ('MetaCons "PeriodicReport" 'PrefixI 'True) (S1 ('MetaSel ('Just "prDates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [DateSpan]) :*: (S1 ('MetaSel ('Just "prRows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PeriodicReportRow a b]) :*: S1 ('MetaSel ('Just "prTotals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PeriodicReportRow () b)))))

data PeriodicReportRow a b

Constructors

PeriodicReportRow

Fields

• prrName :: a
• prrAmounts :: [b]
• prrTotal :: b
• prrAverage :: b

Instances

Functor (PeriodicReportRow a)

Defined in Hledger.Reports.ReportTypes

Methods

fmap :: (a0 -> b) -> PeriodicReportRow a a0 -> PeriodicReportRow a b

(<$) :: a0 -> PeriodicReportRow a b -> PeriodicReportRow a a0

(Show a, Show b) => Show (PeriodicReportRow a b)

Defined in Hledger.Reports.ReportTypes

Methods

showsPrec :: Int -> PeriodicReportRow a b -> ShowS

show :: PeriodicReportRow a b -> String

showList :: [PeriodicReportRow a b] -> ShowS

Generic (PeriodicReportRow a b)

Defined in Hledger.Reports.ReportTypes

Associated Types

type Rep (PeriodicReportRow a b) :: Type -> Type

Methods

from :: PeriodicReportRow a b -> Rep (PeriodicReportRow a b) x

to :: Rep (PeriodicReportRow a b) x -> PeriodicReportRow a b

Num b => Semigroup (PeriodicReportRow a b)

Defined in Hledger.Reports.ReportTypes

Methods

(<>) :: PeriodicReportRow a b -> PeriodicReportRow a b -> PeriodicReportRow a b

sconcat :: NonEmpty (PeriodicReportRow a b) -> PeriodicReportRow a b

stimes :: Integral b0 => b0 -> PeriodicReportRow a b -> PeriodicReportRow a b

(ToJSON b, ToJSON a) => ToJSON (PeriodicReportRow a b)

Defined in Hledger.Reports.ReportTypes

Methods

toJSON :: PeriodicReportRow a b -> Value

toEncoding :: PeriodicReportRow a b -> Encoding

toJSONList :: [PeriodicReportRow a b] -> Value

toEncodingList :: [PeriodicReportRow a b] -> Encoding

type Rep (PeriodicReportRow a b)

Defined in Hledger.Reports.ReportTypes

type Rep (PeriodicReportRow a b) = D1 ('MetaData "PeriodicReportRow" "Hledger.Reports.ReportTypes" "hledger-lib-1.21-9YdjUnmp5UyCwNfm42kb7l" 'False) (C1 ('MetaCons "PeriodicReportRow" 'PrefixI 'True) ((S1 ('MetaSel ('Just "prrName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "prrAmounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [b])) :*: (S1 ('MetaSel ('Just "prrTotal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 b) :*: S1 ('MetaSel ('Just "prrAverage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 b))))

type Percentage = Decimal

type Change

Arguments

 = MixedAmount

A change in balance during a certain period.

type Balance

Arguments

 = MixedAmount

An ending balance as of some date.

type Total

Arguments

 = MixedAmount

The sum of Changes in a report or a report row. Does not make sense for Balances.

type Average

Arguments

 = MixedAmount

The average of Changes or Balances in a report or report row.

periodicReportSpan :: PeriodicReport a b -> DateSpan

Figure out the overall date span of a PeriodicReport

prMapName :: (a -> b) -> PeriodicReport a c -> PeriodicReport b c

Map a function over the row names.

prMapMaybeName :: (a -> Maybe b) -> PeriodicReport a c -> PeriodicReport b c

Map a function over the row names, possibly discarding some.

data CompoundPeriodicReport a b

A compound balance report has:

• an overall title
• the period (date span) of each column
• one or more named, normal-positive multi balance reports, with columns corresponding to the above, and a flag indicating whether they increased or decreased the overall totals
• a list of overall totals for each column, and their grand total and average

It is used in compound balance report commands like balancesheet, cashflow and incomestatement.

Constructors

CompoundPeriodicReport

Fields

• cbrTitle :: Text
• cbrDates :: [DateSpan]
• cbrSubreports :: [(Text, PeriodicReport a b, Bool)]
• cbrTotals :: PeriodicReportRow () b

Instances

Functor (CompoundPeriodicReport a)

Defined in Hledger.Reports.ReportTypes

Methods

fmap :: (a0 -> b) -> CompoundPeriodicReport a a0 -> CompoundPeriodicReport a b

(<$) :: a0 -> CompoundPeriodicReport a b -> CompoundPeriodicReport a a0

(Show a, Show b) => Show (CompoundPeriodicReport a b)

Defined in Hledger.Reports.ReportTypes

Methods

showsPrec :: Int -> CompoundPeriodicReport a b -> ShowS

show :: CompoundPeriodicReport a b -> String

showList :: [CompoundPeriodicReport a b] -> ShowS

Generic (CompoundPeriodicReport a b)

Defined in Hledger.Reports.ReportTypes

Associated Types

type Rep (CompoundPeriodicReport a b) :: Type -> Type

Methods

from :: CompoundPeriodicReport a b -> Rep (CompoundPeriodicReport a b) x

to :: Rep (CompoundPeriodicReport a b) x -> CompoundPeriodicReport a b

(ToJSON b, ToJSON a) => ToJSON (CompoundPeriodicReport a b)

Defined in Hledger.Reports.ReportTypes

Methods

toJSON :: CompoundPeriodicReport a b -> Value

toEncoding :: CompoundPeriodicReport a b -> Encoding

toJSONList :: [CompoundPeriodicReport a b] -> Value

toEncodingList :: [CompoundPeriodicReport a b] -> Encoding

type Rep (CompoundPeriodicReport a b)

Defined in Hledger.Reports.ReportTypes

type Rep (CompoundPeriodicReport a b) = D1 ('MetaData "CompoundPeriodicReport" "Hledger.Reports.ReportTypes" "hledger-lib-1.21-9YdjUnmp5UyCwNfm42kb7l" 'False) (C1 ('MetaCons "CompoundPeriodicReport" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cbrTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "cbrDates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [DateSpan])) :*: (S1 ('MetaSel ('Just "cbrSubreports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, PeriodicReport a b, Bool)]) :*: S1 ('MetaSel ('Just "cbrTotals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PeriodicReportRow () b)))))

data CBCSubreportSpec a

Description of one subreport within a compound balance report. Part of a CompoundBalanceCommandSpec, but also used in hledger-lib.

Constructors

CBCSubreportSpec

Fields

• cbcsubreporttitle :: Text

  The title to use for the subreport

• cbcsubreportquery :: Journal -> Query

  The Query to use for the subreport

• cbcsubreportoptions :: ReportOpts -> ReportOpts

  A function to transform the ReportOpts used to produce the subreport

• cbcsubreporttransform :: PeriodicReport DisplayName MixedAmount -> PeriodicReport a MixedAmount

  A function to transform the result of the subreport

• cbcsubreportincreasestotal :: Bool

  Whether the subreport and overall report total are of the same sign (e.g. Assets are normally positive in a balance sheet report, as is the overall total. Liabilities are normally of the opposite sign.)

data DisplayName

A full name, display name, and depth for an account.

Constructors

DisplayName

Fields

• displayFull :: AccountName
• displayName :: AccountName
• displayDepth :: Int

Instances

Eq DisplayName

Defined in Hledger.Reports.ReportTypes

Methods

(==) :: DisplayName -> DisplayName -> Bool

(/=) :: DisplayName -> DisplayName -> Bool

Ord DisplayName

Defined in Hledger.Reports.ReportTypes

Methods

compare :: DisplayName -> DisplayName -> Ordering

(<) :: DisplayName -> DisplayName -> Bool

(<=) :: DisplayName -> DisplayName -> Bool

(>) :: DisplayName -> DisplayName -> Bool

(>=) :: DisplayName -> DisplayName -> Bool

max :: DisplayName -> DisplayName -> DisplayName

min :: DisplayName -> DisplayName -> DisplayName

Show DisplayName

Defined in Hledger.Reports.ReportTypes

Methods

showsPrec :: Int -> DisplayName -> ShowS

show :: DisplayName -> String

showList :: [DisplayName] -> ShowS

ToJSON DisplayName

Defined in Hledger.Reports.ReportTypes

Methods

toJSON :: DisplayName -> Value

toEncoding :: DisplayName -> Encoding

toJSONList :: [DisplayName] -> Value

toEncodingList :: [DisplayName] -> Encoding

flatDisplayName :: AccountName -> DisplayName

Construct a flat display name, where the full name is also displayed at depth 1

treeDisplayName :: AccountName -> DisplayName

Construct a tree display name, where only the leaf is displayed at its given depth

prrFullName :: PeriodicReportRow DisplayName a -> AccountName

Get the full, canonical, name of a PeriodicReportRow tagged by a DisplayName.

prrDisplayName :: PeriodicReportRow DisplayName a -> AccountName

Get the display name of a PeriodicReportRow tagged by a DisplayName.

prrDepth :: PeriodicReportRow DisplayName a -> Int

Get the display depth of a PeriodicReportRow tagged by a DisplayName.