list_decks {flashr}

List available available flashcard decks

Description

This function searches for flashcard decks stored in GitHub repositories. By default, the function searches the flashr_decks repo. But other GitHub repos can be used.

To narrow the results, include text in the pattern argument (for example, list_decks(pattern = "r4ds")).

Usage

list_decks(
  pattern = NULL,
  repo = "JeffreyRStevens/flashr_decks",
  quiet = FALSE
)

Arguments

pattern

String pattern to search in list of decks.

repo

GitHub username and repo for deck repository in the format of "username/repository". Default value is "JeffreyRStevens/flashr_decks".

quiet

Logical to prevent list information from printing to console.

Details

You are welcome to fork the flashr_decks repo and modify or add your own decks. Or you can create your own repo from scratch. Just make sure to place your decks in a directory called ⁠decks/⁠ in your root directory. Then set the repo argument to your username and repo (see Examples).

Value

Outputs a list of available built-in flashcard decks to the console.

See Also

Other functions for finding decks: choose_deck()

Examples

# View all available decks
list_decks()

# View decks with text matching pattern
list_decks(pattern = "r4ds")

# View decks from specific repository
list_decks(repo = "JeffreyRStevens/flashr_decks")