Structure of the reports

Overview

The purpose of this program is to generate a report based on the raw data contained in the data files. The report is a collection of tables which contain calculated numbers.

Each time you run the program, it creates a new folder based on the current date, and it writes reports in this new folder. The reports are in plain text format, hence you can read these using any text editor such as Notepad++. The reports contains both the a copy of the raw data (the data as found in the input files), as well as numbers which have been calculated from the raw input data.

The reports are available in two forms:

• As a single file which contains all information in one place
• As a serie of files which all contain a subset of the information

Report files

Here is an example of such reports, starting with the full version of the report, and followed by the files that each contain a single section of the report:

investorderly-output-2025-02-01/investorderly-report-full.txt
investorderly-output-2025-02-01/investorderly-report-part-allocations.txt
investorderly-output-2025-02-01/investorderly-report-part-capgains.txt
investorderly-output-2025-02-01/investorderly-report-part-distributions.txt
investorderly-output-2025-02-01/investorderly-report-part-expectations.txt
investorderly-output-2025-02-01/investorderly-report-part-valuations.txt

The full version of the report is more convenient if you want to have all information in one place, so it can be saved easily. The split version of the report is more useful if you just want to read a specific section of the report, as it gives you a direct access to what you are interested in.

Terminology

The tables in the report contain columns named “holdings”. An holding is a term used to refer to a combination of an asset and a particular account. For example, if you own the same stock in multiple accounts, these are considered as different holdings.