ankiR (version 0.6.0)

anki_retention_rate: Calculate actual retention rate from review history

Description

Calculates the proportion of reviews that were successful (not "Again").

Usage

anki_retention_rate(path = NULL, profile = NULL, days = 30, by_deck = FALSE)

Value

A tibble with retention statistics

Arguments

path

Path to collection.anki2 (auto-detected if NULL)

profile

Profile name (first profile if NULL)

days

Number of days to look back (default 30, NULL for all)

by_deck

If TRUE, calculate retention per deck

Examples

if (FALSE) {
retention <- anki_retention_rate()
retention <- anki_retention_rate(days = 90, by_deck = TRUE)
}