plot_progress: Plot users progress

Description Usage Arguments Value

View source: R/plots.R

Description

Plot the progress on one or more decks for a user's home directory.

Usage

1
2
plot_progress(user_dir = getwd(), decks = NULL, progress = "progress.tsv",
  library = "decks", min_cards = 10)

Arguments

user_dir

The path to the folder containing the deck library, progress file, and history file. If the folder was created using init_user_dir, this is the only argument needed. By default, this is the current working directory.

decks

The names or folder paths of one or more decks to practice on. If "library" is supplied, then these paths are relative to it. By default, all decks in "library" are used.

progress

The file used to store a user's progress for one or more decks. By default, this is a file called "progress.tsv". If "user_dir" is supplied, then this paths is relative to it. If NULL, no progress file is used.

library

The path to the deck library. This is where the user stores their decks and practice history. By default, this is a directory called "decks" in the user folder. If "user_dir" is supplied, then this paths is relative to it.

min_cards

Decks with fewer cards than this will be compressed into a single deck.

Value

a ggplot object


zachary-foster/flashcards documentation built on April 23, 2020, 7:26 a.m.