Statistics And Reports - banisterious/obsidian-charted-roots GitHub Wiki

Statistics & Reports

Charted Roots provides a comprehensive statistics dashboard and report generation system to help you understand your data and generate formatted genealogical reports.

Table of Contents

Overview

The Statistics & Reports system provides:

  • Statistics Dashboard: A dedicated workspace view with metrics, drill-down lists, and demographic analysis
  • Reports Generator: Create formatted genealogical reports (Family Group Sheets, Pedigree Charts, etc.)
  • Control Center Summary: Quick-glance metrics in the Dashboard tab

The system uses a shared data layer ensuring consistency between dashboard metrics and generated reports.

Statistics Dashboard

The Statistics Dashboard is a full-featured workspace view that provides detailed insights into your vault data.

Opening the Dashboard

There are several ways to open the Statistics Dashboard:

  1. From Control Center: Dashboard tab β†’ "Statistics" tile
  2. Command Palette: "Charted Roots: Open Statistics Dashboard"
  3. Ribbon icon: Click the statistics icon in the left ribbon (if enabled)

The dashboard can be pinned alongside notes in split view and auto-refreshes when vault data changes.

Entity Overview

The Entity Overview section displays counts for each entity type in your vault:

Entity Type Description
People Total person notes
Events Total event notes
Sources Total source notes
Places Total place notes
Organizations Total organization notes
Canvases Total canvas files

Also shows the date range spanning all entities (earliest to latest dates).

Data Completeness

Track how complete your research is with percentage metrics:

Metric Description
With birth date % of people with birth dates recorded
With death date % of people with death dates recorded
With sources % of people with at least one source citation
With father % of people with father linked
With mother % of people with mother linked
With spouse % of people with spouse linked

Progress bars are color-coded: green (80%+), yellow (50-79%), red (below 50%).

Data Quality

The Data Quality section identifies issues in your data. Click any issue to expand and see the affected records.

Issue Type Severity Description
Date inconsistencies Error People with birth after death, or implausible age (over 120 years; disabled when fictional dates are enabled)
Missing birth dates Warning People without birth date recorded
Missing death dates Warning People with birth but no death (excluding living)
Orphaned people Warning People with no relationships (no parents, spouse, or children)
Incomplete parents Warning People with only one parent linked
Unsourced events Info Events without source citations
Places without coordinates Info Place notes missing latitude/longitude

Drill-down features:

  • Click an issue to expand and see affected records
  • Click a person/file chip to open in new tab
  • Right-click for context menu (open to right, new window)
  • Ctrl+hover for preview popup

Gender Distribution

Displays the breakdown of sex/gender values in your person notes:

  • Male, Female, Other, Unknown counts with percentages
  • Visual bar chart showing distribution
  • Expandable person lists under each category β€” click "Show" to see clickable links to person notes:
    • Other entries show the actual value entered (e.g., "non-binary")
    • Unknown is split into "explicitly stated" (sex: unknown) and "not stated" (missing property) for easy back-filling
    • Categories with zero entries are hidden

Top Lists

Interactive lists showing the most common values, with drill-down to see matching people:

List Description
Top Surnames Most common surnames with counts
Top Locations Most referenced birth/death places
Top Occupations Most common occupations
Top Sources Most frequently cited sources

Click a row to expand and see all people matching that surname, location, or occupation. Click a person chip to open their note.

Extended Statistics

Advanced demographic analysis for deeper research insights:

Longevity Analysis

  • Average, median, min, and max lifespan across all people
  • Lifespan trends by birth decade
  • Lifespan by birth location

Family Size Patterns

  • Average number of children per family
  • Family size distribution (0, 1-2, 3-4, 5+ children)
  • Trends by birth decade

Marriage Patterns

  • Average age at first marriage by sex
  • Remarriage rates and statistics

Migration Flows

  • Migration rate (% who died in different location than birth)
  • Top migration routes (from β†’ to)
  • Top destinations and origins

Source Coverage by Generation

  • Coverage percentage by generation depth
  • Average sources per person by generation

Timeline Density

  • Events per decade visualization
  • Gap detection (periods with unusually low activity)

Record Superlatives

The Record Superlatives section highlights notable individuals across eight categories:

Category Description
Oldest people Longest-lived individuals by lifespan
Youngest deaths Shortest lifespans (excluding infants under 1 year)
Most children People with the most children
Most marriages People with the most spouses
Longest marriages Marriages with the longest duration
Earliest births People born earliest in the dataset
Most recent deaths People who died most recently
Most documented People with the most source citations

Each category shows the top 3 entries as a card with:

  • Ranked entries with gold highlighting for first place
  • Clickable person links (click to open, right-click for context menu, hover for preview)
  • Birth and death dates
  • The record value (e.g., "87 years", "12 children", "54 years married")

Citation Statistics

The Citation Statistics section shows metrics about citation notes in your vault. Hidden when no citation notes exist.

Metric Description
Total citations Number of citation notes in the vault
Citation coverage Percentage of sourced facts that have citation-level detail (page reference or quality assessment)
Quality distribution Breakdown of citation quality values: Primary (3), Secondary (2), Questionable (1), Unreliable (0)
Most cited sources Top 5 sources ranked by number of citation notes

Reports

Generate formatted reports from your data. Reports are organized into categories for easy discovery. Reports that target a specific universe or collection provide fuzzy-search picker modals for selection.

Report Categories

Category Reports
Genealogical Ahnentafel, Pedigree Chart, Descendant Chart, Register Report, Family Group Sheet, Individual Summary, Kinship Report
Research Source Summary, Gaps Report, Brick Wall Report, Unconnected People Finder, Media Inventory
Timeline Timeline Report
Geographic Place Summary
Summary Universe Overview, Collection Overview
Visual Trees Pedigree Tree PDF, Descendant Tree PDF, Hourglass Tree PDF

Visual Tree Reports

Generate printable PDF tree diagrams with positioned boxes and connecting lines.

Report Description
Pedigree Tree PDF Graphical ancestor tree with root at bottom, ancestors branching upward
Descendant Tree PDF Graphical descendant tree with root at top, descendants branching downward
Hourglass Tree PDF Both ancestors above and descendants below the root person

Clicking any Visual Tree report opens the unified tree wizard, which guides you through:

  1. Selecting a root person
  2. Choosing tree type and generation limits
  3. Selecting output format (PDF is pre-selected)
  4. Configuring PDF options (page size, orientation, colors)
  5. Generating and downloading the PDF

See Canvas Trees for detailed wizard documentation.

Genealogical Reports

Report Description
Family Group Sheet Single family unit with parents, marriage, and children
Individual Summary Complete record of one person with all events and sources
Ahnentafel Report Numbered ancestor list (1=subject, 2=father, 3=mother, etc.)
Gaps Report Analysis of missing data by category with research level filtering
Register Report Descendants with NGSQ-style numbering
Pedigree Chart Ancestor tree in ASCII art format
Descendant Chart Descendant tree in ASCII art format
Kinship Report All relatives of a person with genealogical relationship terms and degree

Kinship Report

The Kinship Report lists all people connected to a selected person with proper genealogical relationship terms: parents, siblings, cousins (with removals), in-laws, great-grandparents, and more.

Options:

Option Description
Root person The person to calculate relationships from
Max degree Maximum relationship degree to include (free numeric input, no upper limit)

Report contents:

  • Each relative is listed with their name, relationship description (e.g., "2nd cousin 1 time removed"), total degree, and whether the connection is by blood or marriage
  • Sortable by degree (closest first), name, or relationship type
  • Summary includes total relatives, blood vs. marriage breakdown, furthest degree found, and counts by category (spouses, siblings, cousins, in-laws, etc.)

Gaps Report

The Gaps Report identifies missing data across your person notes. When Research Tools are enabled in settings, the report includes research level features:

Research Level Filter: Limit the report to people at or below a specific research level (0-6). This helps you focus on ancestors who need the most work.

Research Level Statistics: The report summary includes:

  • Breakdown by category (Needs work 0-2, Partially researched 3-4, Well researched 5-6)
  • Count of unassessed people
  • Per-level counts

Research Level Column: Each table (missing birth dates, missing parents, etc.) shows each person's research level.

Sort by Research Level: Optionally sort results with lowest research levels first, so the ancestors needing most work appear at the top.

See Frontmatter Reference for details on the research level system.

Research Reports

Report Description
Source Summary All sources cited for a person, grouped by fact type with quality ratings and gap analysis
Sources by Role All sources where a person appears as witness, informant, official, or other role
Brick Wall Report Identifies end-of-line ancestors with no parents defined
Unconnected People Finder Identifies people not linked to a selected person's family network
Media Inventory Media files with linked entities, orphaned file detection, coverage gaps

Sources by Role

The Sources by Role report shows all sources where a selected person appears in any roleβ€”not just as the subject, but also as a witness, informant, official, family member, or other named person.

Use cases:

  • FAN research: Build Friends, Associates, and Neighbors networks by finding where people appear together
  • Information quality: Identify who provided information on death certificates and other records
  • Enslaved ancestor research: Track individuals through probate records, wills, and inventories

Options:

Option Description
Person The person to search for across all sources
Role filter Limit to specific roles (e.g., only witnesses)
Group by Organize results by role, by source, or chronologically
Show role details Include details like "Decedent", "Administrator"
Show source quality Include quality ratings (primary/secondary/derivative)
Show repository Include repository information

Output: A markdown report with a summary of sources by role and detailed tables.

See Person Roles in Sources for details on setting up role properties on source notes.

Brick Wall Report

The Brick Wall Report identifies end-of-line ancestors β€” people in your ancestor tree with no parents defined, as well as missing parent slots where only one parent line is known. This helps focus research efforts on the most productive lines.

Options:

Option Description
Root person The person to trace ancestors from
Max generations How many generations to traverse (free numeric input, no upper limit)

Report contents:

  • Each brick wall entry shows the person's name, generation number, Ahnentafel number, lineage path (e.g., "Father > Mother > Father"), source count, and research level
  • Sortable by generation (nearest first), name, or research level (least researched first)
  • Summary includes tree completeness statistics and per-generation breakdown
  • Available in all output formats: vault markdown, download, PDF (landscape layout), and ODT

Unconnected People Finder

The Unconnected People Finder identifies people not linked to a selected person's family network. This is useful for finding orphaned records after imports or identifying separate family lines that should be connected.

Options:

Option Description
Root person The person whose network to check against

Report contents:

  • Uses connected component analysis to find disconnected clusters and completely isolated records
  • Shows network coverage percentage (how much of your vault is connected to the root person)
  • Groups unconnected people by cluster (groups of people connected to each other but not to the root person)
  • Lists isolated people separately (no connections at all)
  • Available in all output formats: vault markdown, download, PDF, and ODT

Timeline Reports

Report Description
Timeline Report Chronological list of events with filtering by date range, event type, and participants

Geographic Reports

Report Description
Place Summary All events and people at a location (born, died, resided, married) with hierarchy display

Summary Reports

Report Description
Universe Overview Entity statistics for a fictional world with date ranges and breakdowns
Collection Overview Summary of a user collection or family component with member list and statistics

Generating Reports

There are several ways to access report generation:

  • Command palette β€” Press Ctrl/Cmd + P and search for Charted Roots: Open report wizard
  • Control Center dashboard β€” Click the Reports Wizard tile
  • Trees & Reports tab β€” Click Open report wizard (next to Book Builder)
  • Person context menu β€” Right-click a person note β†’ Charted Roots > Generate report (pre-selects the person)
  • Individual report cards β€” In Trees & Reports, click Generate on a specific report type

Using the Report Wizard:

  1. Select a report category (person, family, place, or source)
  2. Choose the specific report type
  3. Select the subject (person, place, etc.)
  4. Configure options:
    • Set maximum generations
    • Choose what details to include
    • Select output method (new note or clipboard)
  5. Click "Generate"

Report Options

Common options available for most reports:

Option Description
Root person The starting person for the report
Maximum generations How many generations to include (free numeric input, no upper limit)
Include details Show birth/death dates and places
Include spouses Show spouse information
Include sources Include source citations
Output method Save to vault, Download as MD, or Download as PDF
Output folder Where to save the generated note (vault only)

PDF Export

All report types can be exported as professionally styled PDF documents. PDFs are generated entirely locallyβ€”no internet connection required.

PDF Options

When "Download as PDF" is selected, additional options appear:

Option Description
Page size A4 or Letter
Include cover page Add a title page with report name, subject, and generation date
Logo or crest Optional image to display on the cover page (shown when cover page is enabled)
Custom title Override the default report title
Custom title scope Apply custom title to cover only, headers only, or both
Custom subtitle Additional text below title on cover page
Cover notes Extended notes section on cover page
Date format MDY (12/20/2025), DMY (20/12/2025), or YMD (2025-12-20)

Cover Page

The optional cover page includes:

  • Report title (e.g., "Ahnentafel Report")
  • Subject name (e.g., "Ancestors of John Smith")
  • Decorative separator line
  • Generation date
  • "Charted Roots for Obsidian" branding

If a logo is provided, it appears centered at the top of the cover page. Images are automatically resized to reduce PDF file size.

Privacy & Security

Genealogical data is highly personal. When you select "Download as PDF" or "Download as MD", a privacy message confirms:

  • 100% local generation β€” PDFs are created entirely on your device using the pdfmake library bundled with the plugin
  • No internet connection required β€” No data is sent to any server or cloud service
  • No external dependencies β€” Fonts are embedded; no network requests are made during generation
  • Downloads to your system β€” Files save to your operating system's Downloads folder, outside your vault

This ensures your family data never leaves your computer during report generation.

Control Center Summary

The Dashboard tab in Control Center provides a quick overview via the Vault health section:

  • Entity counts at a glance
  • Research completeness percentage
  • Data quality warning indicators
  • "Statistics" tile to open the full Statistics Dashboard

This summary is useful for quick health checks without opening the full dashboard.

Related Documentation