Skip to content

Study Dashboard

Jump to bottom
hugomarins edited this page May 20, 2026 · 2 revisions

Study Dashboard

The Study Dashboard is a filterable popup that summarizes your Incremental, Dismissed, and Flashcard activity across the whole knowledge base or scoped to a single document, with a fully expandable hierarchy view showing time, reps, retention, and speed at every level of your rem tree.

It was inspired by the Statistics Plugin (period filters and context selector) and combines those controls with data from the existing Aggregated Repetition History and Practiced Queues History widgets.

Table of Contents

What it shows

The popup has two stacked sections:

  1. Summary — three rows (Incremental, Dismissed, Flashcards) plus a bold Total row, with columns for Items, Items w/ Reps, Reps, Time, and (for Flashcards) average retention and speed.
  2. Hierarchy — every top-level rem with activity in the selected period, expandable into the full ancestor tree. Each row shows total time, card reps + time, IncRem reps + time (sum of Incremental + Dismissed history), retention %, and speed in cards-per-minute.
Study Dashboard

Opening it

  • Command Palette: Open Study Dashboard (quick code sdb)
  • The dashboard always opens in Global mode by default.
  • If a rem is focused in the editor (or you're reviewing a card in the queue), the command passes it along as the Document-mode root — you can switch to Document inside the popup at any time. Without a rem context, the Document radio is greyed out and Global is the only option.

Filters

Context

  • Global — every IncRem, Dismissed rem, and Card-bearing rem across the entire KB.
  • Document — only rems in scope of the rem you opened the dashboard from. Two scope sub-modes:
    • Descendants Only — rootRem and every descendant via getDescendants().
    • Comprehensive — uses the same scope expansion as the rest of the plugin: descendants, rems in the same document/portal, folder-queue contents, source documents (recursively), referencing rems, PDF extracts and PDF descendants. See Prioritization & Sorting → Comprehensive scope for the full definition.

The Document option is greyed out if the dashboard was opened without any rem context.

Period

Twelve presets in a tidy 5×3 grid, plus an All button and explicit Start / End date inputs:

Today Week Month Year All
Yesterday This Week This Month This Year
Last Week Last Month Last Year
  • Clicking a preset auto-fills both date inputs to the resolved range.
  • Editing either date directly switches the picker to custom.
  • All clears the inputs (no meaningful start date).
  • Default on first open is This Year.

Summary section

Column Meaning
Items Total rems tagged (or, for Flashcards, total cards) in the selected scope — period-independent.
w/ Reps Subset of the above that had at least one repetition inside the period.
Reps Total qualifying repetitions in the period.
Time Total review time in the period.
Ret. (Flashcards only) (reps − again-count) / reps, color-coded ≥90 % green / <80 % red / yellow.
Speed (Flashcards only) Cards per minute, color-coded with a 1.5 → 4 cpm gradient.

The percentages next to Incremental and Dismissed show each one's share of Incremental + Dismissed items.

The bold Total row sums Items / w-Reps / Reps / Time across the three types. Retention and Speed are not aggregated across types (they aren't meaningfully addable).

Filtering rules match the plugin's other authoritative-summary tooling:

  • Cards count only when scored AGAIN, HARD, GOOD, or EASY (RemNote's TOO_EARLY, VIEWED_AS_LEECH, RESET, MANUAL_DATE, MANUAL_EASE are excluded).
  • IncRem reps count only for rep, executeRepetition, and rescheduledInQueue event types (rescheduledInEditor, manualDateReset, lifecycle markers are excluded).
  • Card response time is capped by the Flashcard response time limit setting (default 180 s). IncRem reviewTimeSeconds is intentionally uncapped — an IncRem rep can legitimately span minutes of reading.

Hierarchy section

The hierarchy lists every rem with activity inside the selected period, organized as a collapsible tree:

  • Top-level rows = rems whose parent is null or outside the scope. Sorted by total time descending.
  • Click ▶ to expand a branch and reveal the full subtree under it. Children are sorted by total time descending too.
  • Rems that are themselves Incremental or Dismissed get a colored dot (●) next to their name.
  • The ↗ icon on each row opens the rem in the editor (PDF-aware: PDF highlights/extracts open as a page).
  • Branches with zero reps in the period are pruned at every level. If you change to All, more rems re-appear.
  • Structural ancestor nodes — rems that have no own data but are needed to keep the tree connected — render in italics with reduced opacity. Their numbers are the bottom-up aggregate of their descendants.

Each row's columns:

Column Meaning
Total Time Card time + IncRem time, summed across the subtree (in the period).
Cards Card reps in the period, with the time spent in parentheses.
Inc. Rems IncRem reps including history of dismissed rems in the period, with time in parentheses.
Ret. Retention across all cards in the subtree (in the period).
Speed Cards-per-minute across the subtree.

Global mode — top-level rems

In Global mode, a "top-level rem" is the highest ancestor (where parent === null) that has, anywhere in its subtree, at least one IncRem rep or card rep inside the selected period. Each top-level row's numbers are the bottom-up aggregate of everything beneath it.

Document mode — root

In Document mode the root row is the rem the dashboard was opened from (or its closest in-scope ancestor when in Comprehensive mode, see below).

Global vs. Document

Global Document — Descendants Document — Comprehensive
Scope Every IncRem, Dismissed, and card-bearing rem in the KB rootRem.getDescendants() (inclusive of rootRem) Same as the rest of the plugin's comprehensive scope: descendants + portals + folder queue + referencing rems + sources (recursive) + PDF extracts/descendants
Roots in the hierarchy All top-level KB rems with activity The selected rem Same — plus structural rems above when comprehensive expansion reached outside the rem's own subtree

Comprehensive scope + hierarchy

The Comprehensive scope, by construction, can include rems whose parents are not themselves in the scope (e.g. a PDF extract belonging to a source document referenced from inside the document being analyzed). To keep the rendered tree connected and intelligible, the dashboard walks every in-scope rem's parent chain and materializes any missing ancestors as structural-only nodes — italic rows with no self-data, whose role is purely to give the tree a coherent shape from each leaf up to a real root.

The aggregate numbers on a structural node are the sum of its descendants — so even though the node has no reps of its own, it gives you a meaningful per-branch breakdown.

Performance notes

The dashboard's data load can be heavy on large knowledge bases. Several optimizations keep it manageable:

  1. Bulk fetching: at load time the dashboard issues a small fixed set of bulk calls — taggedRem() for the Incremental, Dismissed, and cardPriority powerups, plus a single card.getAll() — instead of per-rem RPCs. Because the cardPriority powerup typically covers every card-bearing rem in a KB, those bulk calls provide free parent and text info for the vast majority of rems-with-data, so chain-walking needs almost zero additional findOne calls.
  2. Period changes are instant: the heavy data load happens once per session/scope. Switching the period reuses the cached data and performs only an in-memory aggregation pass.
  3. Pre-built subtrees: in Global mode the per-top-level subtrees are assembled at load time from the cached parent chains. Expanding any top-level row is therefore instant, with no further RPCs.
  4. Parallel ancestor walks: ancestor chains are resolved in chunks of 50 with an in-flight promise cache, so sibling rems that share an ancestor path do that work only once.
  5. Progress bar: the popup shows a progress bar during loading (0–80 % for fetch, 80–100 % for aggregation) with a label so you can see what phase it's in.

When you change the context (Global ↔ Document) or scope (Descendants ↔ Comprehensive), the dashboard reloads the relevant data set. When you only change the period, it doesn't.

Command

Command Quick Code Description
Open Study Dashboard sdb Opens the dashboard popup. Auto-detects the focused rem in the editor or the current card in the queue and uses it as the Document-mode root. If no rem context is available it opens in Global mode.

📖 See Plugin Commands Reference for the full command list.

User's Manual

Clone this wiki locally