set.sylly.env: A function to set information on your sylly environment
Description
The function set.sylly.env can be called before any of the hyphenation functions. It preserves some information
on your current session's settings to a hidden environment.
Usage
set.sylly.env(..., validate = TRUE)
Arguments
...
Named parameters to set in the sylly environment. Valid arguments are:
lang
A character string specifying a valid language.
hyph.cache.file
A character string specifying a path to a file to use for storing already hyphenated data,
used by hyphen.
hyph.max.token.length
A single number to set the internal cache size for tokens. The value should be set to the longest token to be hyphenated.
To explicitly unset a value again, set it to an empty character string (e.g.,
lang="").
validate
Logical,
if TRUE given paths will be checked for actual availablity, and the function will fail if files can't be found.
Value
Returns an invisible NULL.
Details
To get the contents of the hidden environment,
the function get.sylly.env
can be used.