set.kRp.env: A function to set information on your koRpus environmenton

Description

The function set.kRp.env can be called once before any of the analysing functions. It writes information on your session environment regarding the koRpus package, e.g. path to a local TreeTagger installation, to a hidden environment.

Usage

set.kRp.env(..., validate = TRUE)

Arguments

...

Named parameters to set in the koRpus environment. Valid arguments are:

TT.cmd: A character string pointing to the tagger command you want to use for basic text analysis, or "manual" if you want to set TT.options as well. Set to "tokenize" to use tokenize.
lang: A character string specifying a valid language.
TT.options: A list with arguments to be used as TT.options by treetag.
hyph.cache.file: A character string specifying a path to a file to use for storing already hyphenated data, used by hyphen.

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 hitten environment, the function get.kRp.env can be used.

Examples

Run this code

# NOT RUN {
set.kRp.env(TT.cmd="~/bin/treetagger/cmd/tree-tagger-german", lang="de")
get.kRp.env(TT.cmd=TRUE)
# }