run_wordbox: Run the application

In stibu81/WordBox: A Simple Vocabulary Trainer

Run the application

Description

Run the application

Usage

run_wordbox(
  dir = NULL,
  launch.browser = NULL,
  config_file = NULL,
  log_file = NULL,
  show_errors = TRUE,
  n_words_default = 30,
  rm_trailing_chars = ""
)

Arguments

dir	character indicating a directory where wordlist files (csv) are stored. All the csv files in that directory will be available to be loaded in the application.
launch.browser	logical, if TRUE, the application is opened in the system's default browser, if FALSE, no browser is started. If the argument is omitted, the value according to the option shiny.launch.browser is used, which in RStudio opens the internal shiny viewer.
config_file	character giving the full path to the configuration file. If omitted, the default configuration is used. See read_config for details on the config file.
log_file	If a valid path is provided, the quiz will write its log to the file. If the file exists and is a log file produced by WordBox, new entries will be appended. A file that was not produced by WordBox will not be modified.
show_errors	should the UI show the number of errors that were made during a quiz.
n_words_default	integer indicating the default for the number of words per quiz. This value must lie between 5 and 95.
rm_trailing_chars	a character of length one containing characters that should be removed if they appear at the end of an answer. This can be used to omit rejecting answers because a key next to Return is hit by accident. For a Swiss keyboard, rm_trailing_chars = "$" is an appropriate choice.

stibu81/WordBox documentation built on Nov. 28, 2024, 2:29 p.m.