practice: Start a practice session

Description Usage Arguments

View source: R/practice.R

Description

Start practicing one or more decks.

Usage

1
2
3
practice(user_dir = getwd(), decks = NULL, progress = "progress.tsv",
  library = "decks", history = "history.tsv", tests = test_names(),
  record = TRUE, focus = 0.5, max_tests = 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_dir" folder. If "user_dir" is supplied, then this paths is relative to it.

history

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

tests

The names of test types to use in this practice session. By default, the practice types specified by the decks are used.

record

If TRUE, update the user's practice history with the results of this practice session.

focus

A number between 0 amd 1. Low numbers means less well known cards will be practiced, whereas higher number means more well known cards will be practiced.

max_tests

The number of cards to present.


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