read_wordlist: Read a word list file

In stibu81/WordBox: A Simple Vocabulary Trainer

Read a word list file

Description

Read a word list file

Usage

read_wordlist(file, config_file = NULL)

get_wordlist_testfile()

Arguments

file	character with the full path to the word list file
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.

Details

get_wordlist_testfile() returns the file name of a wordlist file that can be used for tests.

Value

a wordlist object, which is a data frame with the following columns:

language1

words in the first language

language2

words in the second language

group

name of the group that the words belong to

core

is the word part of the core vocabulary?

exam

is the word part of the current exam?

box1

the box in which the words are in the mode 1 > 2

count1

the number of consecutive successes in the current box in the mode 1 > 2

date1

the date of the last success in the mode 1 > 2

box2

the box in which the words are in the mode 2 > 1

count2

the number of consecutive successes in the current box in the mode 2 > 1

date2

the date of the last success in the mode 2 > 1

The full names of the two languages are returned as attribute of the wordlist and can be obtained using get_languages.

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