blob: 16a6838fb7c39d5146ff4b545208166e8e1c4f08 (
about) (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
;;; org-fc-dashboard.el --- Dashboard for the SRS -*- lexical-binding: t; -*-
;; Copyright (C) 2020 Leon Rische
;; Author: Leon Rische <emacs@leonrische.me>
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
(require 'svg)
(require 'org-fc-review)
(require 'org-fc-awk)
;;; Configuration
(defcustom org-fc-dashboard-bar-chart-width 400
"Width of the svg generated to display review statistics."
:type 'integer
:group 'org-fc)
(defcustom org-fc-dashboard-bar-chart-height 20
"Height of the svg generated to display review statistics."
:type 'integer
:group 'org-fc)
(defcustom org-fc-dashboard-buffer-name "*org-fc Main*"
"Name of the buffer to use for displaying the dashboard view."
:type 'string
:group 'org-fc)
;;; Statistics
(defun org-fc-review-estimate (paths n)
"Positions due in the next N days"
(let ((now (+ (time-to-seconds (current-time))
(* 60 60 24 n))))
(count-if
(lambda (pos) (< (time-to-seconds (plist-get pos :due)) now))
(org-fc-awk-positions-for-paths paths))))
;;; Bar-Chart Generation
(defun org-fc-dashboard-bar-chart (stat)
"Generate a svg bar-chart for the plist STAT"
(let* ((width org-fc-dashboard-bar-chart-width)
(height org-fc-dashboard-bar-chart-height)
(total (float (plist-get stat :total)))
(values
`((,(/ (plist-get stat :again) total) . "red")
(,(/ (plist-get stat :hard) total) . "yellow")
(,(/ (plist-get stat :good) total) . "green")
(,(/ (plist-get stat :easy) total) . "darkgreen")))
(svg (svg-create width height)))
(do ((values values (cdr values))
(pos 0 (+ pos (* width (caar values)))))
((null values) '())
(svg-rectangle svg pos 0 (* width (caar values)) height :fill (cdar values)))
(svg-image svg)))
(defun org-fc-dashboard-percent-right (stats)
(let ((total (float (plist-get stats :total))))
(format " %5.2f | %5.2f | %5.2f | %5.2f"
(or (* 100 (/ (plist-get stats :again) total)) 0.0)
(or (* 100 (/ (plist-get stats :hard) total)) 0.0)
(or (* 100 (/ (plist-get stats :good) total)) 0.0)
(or (* 100 (/ (plist-get stats :easy) total)) 0.0))))
;;; Main View
;; Based on `mu4e-main-view-real'
(defun org-fc-dashboard-view ()
(interactive)
(let* ((buf (get-buffer-create org-fc-dashboard-buffer-name))
(inhibit-read-only t)
(cards-stats (org-fc-awk-stats-cards))
(positions-stats (org-fc-awk-stats-positions))
(reviews-stats (org-fc-awk-stats-reviews)))
(with-current-buffer buf
(erase-buffer)
(insert
(propertize "Flashcards\n\n" 'face 'org-level-1))
(insert
(propertize " Card Statistics\n\n" 'face 'org-level-1))
(insert (format " New: %d (day) %d (week) %d (month) \n"
(plist-get cards-stats :created-day)
(plist-get cards-stats :created-week)
(plist-get cards-stats :created-month)))
(insert "\n")
(insert (format
" %6d Cards, %d suspended\n"
(plist-get cards-stats :total)
(plist-get cards-stats :suspended)))
(dolist (position '((:type-normal . "Normal")
(:type-double . "Double")
(:type-text-input . "Text Input")
(:type-cloze . "Cloze")))
(insert
(format " %6d %s\n"
(or (plist-get cards-stats (car position)) 0)
(cdr position))))
(insert "\n")
(insert
(propertize " Position Statistics\n\n" 'face 'org-level-1))
(insert (format " %6d Due Now\n\n" (plist-get positions-stats :due)))
(dolist (position '((:avg-ease . "Avg. Ease")
(:avg-box . "Avg. Box")
(:avg-interval . "Avg. Interval (days)")))
(insert
(format " %6.2f %s\n"
(plist-get positions-stats (car position))
(cdr position))))
(insert "\n")
(when reviews-stats
(insert
(propertize " Review Statistics\n\n" 'face 'org-level-1))
(dolist (scope '((:day . "Day")
(:week . "Week")
(:month . "Month")
(:all . "All")))
(when-let (stat (plist-get reviews-stats (car scope)))
(when (plusp (plist-get stat :total))
(insert (propertize (format " %s (%d)\n" (cdr scope) (plist-get stat :total)) 'face 'org-level-1))
(insert " ")
(insert-image (org-fc-dashboard-bar-chart stat))
(insert (org-fc-dashboard-percent-right stat))
(insert "\n\n"))))
(insert "\n"))
(insert
(propertize " [r] Review\n" 'face 'org-level-1))
(insert
(propertize " [q] Quit\n" 'face 'org-level-1)))))
(defvar org-fc-dashboard-mode-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "r") 'org-fc-review-all)
(define-key map (kbd "q") 'quit-window)
(define-key map (kbd "G") 'org-fc-dashboard-view)
map))
(define-derived-mode org-fc-dashboard-mode special-mode "org-fc main"
"Major mode providing an overview of the flashcard system"
(set (make-local-variable 'revert-buffer-function) #'org-fc-dashboard-view)
(setq-local cursor-type nil))
;;;###autoload
(defun org-fc-dashboard ()
(interactive)
(org-fc-dashboard-view)
(switch-to-buffer org-fc-dashboard-buffer-name)
(goto-char (point-min))
(org-fc-dashboard-mode))
;;; Exports
(provide 'org-fc-dashboard)
|
