i18n_dict: Dictionary
In pmcharrison/psychTestR: Framework for delivering psychological tests via Shiny
i18n_dict R Documentation
Dictionary
Description
Dictionaries allow psychTestR tests to
support multiple languages during test administration.
These dictionaries (class name: i18n_dict)
define mappings between string keys (e.g. prompt1)
and (potentially) multiple outputs,
each corresponding to different languages (e.g. English, German).
The dictionary is passed as an argument to new_timeline,
and provides the context for the evaluation of calls to
i18n, responsible for translating individual terms.
Methods
i18n_dict$new(x, markdown) defines and returns a new dictionary
which can be saved as an object.
Its first argument, x, should be a data frame defining the dictionary.
Each row of this data frame should correspond to a term to be translated.
It should have a column entitled 'key', which defines the identifying
keys for each term.
All other columns should provide translations into different languages,
with the language being identified by the column name,
according to ISO 639-2 conventions (lower-case, e.g. 'en').
The second argument, markdown, is a scalar Boolean (default = TRUE)
that determines whether the data frame is formatted in
Markdown or not (Markdown allows for efficient and readable
text markup, e.g. italic and bold).
Text is parsed according to standard Markdown conventions,
with one addition: two successive backslashes
(written "\" in a text file, or "\\" in R)
are interpreted as a new paragraph.
x$as.data.frame, where x is a dictionary object,
converts the dictionary back to a data frame representation.
x$edit(key, language, new),
edits a given entry in the dictionary for a given key and language,
replacing it with the value new.
See the vignette "Editing dictionaries" for details.
x$translate(key, language, allow_missing)
uses the dictionary x
to translate key into language.
If allow_missing is TRUE, then NULL is returned
when no translation is found, otherwise an error is thrown.
Methods
Public methods
-
-
-
-
-
-
Method new()
Usage
i18n_dict$new(x, markdown = TRUE)
Method as.data.frame()
Usage
i18n_dict$as.data.frame()
Method translate()
Usage
i18n_dict$translate(key, language, allow_missing = FALSE)
Method edit()
Usage
i18n_dict$edit(key, language, new)
Method print()
Usage
i18n_dict$print(...)
Method clone()
The objects of this class are cloneable with this method.
Usage
i18n_dict$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
pmcharrison/psychTestR documentation built on Nov. 10, 2024, 9:03 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| i18n_dict | R Documentation |
Dictionary
Description
Dictionaries allow psychTestR tests to
support multiple languages during test administration.
These dictionaries (class name: i18n_dict)
define mappings between string keys (e.g. prompt1)
and (potentially) multiple outputs,
each corresponding to different languages (e.g. English, German).
The dictionary is passed as an argument to new_timeline,
and provides the context for the evaluation of calls to
i18n, responsible for translating individual terms.
Methods
i18n_dict$new(x, markdown) defines and returns a new dictionary
which can be saved as an object.
Its first argument, x, should be a data frame defining the dictionary.
Each row of this data frame should correspond to a term to be translated.
It should have a column entitled 'key', which defines the identifying
keys for each term.
All other columns should provide translations into different languages,
with the language being identified by the column name,
according to ISO 639-2 conventions (lower-case, e.g. 'en').
The second argument, markdown, is a scalar Boolean (default = TRUE)
that determines whether the data frame is formatted in
Markdown or not (Markdown allows for efficient and readable
text markup, e.g. italic and bold).
Text is parsed according to standard Markdown conventions,
with one addition: two successive backslashes
(written "\" in a text file, or "\\" in R)
are interpreted as a new paragraph.
x$as.data.frame, where x is a dictionary object,
converts the dictionary back to a data frame representation.
x$edit(key, language, new),
edits a given entry in the dictionary for a given key and language,
replacing it with the value new.
See the vignette "Editing dictionaries" for details.
x$translate(key, language, allow_missing)
uses the dictionary x
to translate key into language.
If allow_missing is TRUE, then NULL is returned
when no translation is found, otherwise an error is thrown.
Methods
Public methods
Method new()
Usage
i18n_dict$new(x, markdown = TRUE)
Method as.data.frame()
Usage
i18n_dict$as.data.frame()
Method translate()
Usage
i18n_dict$translate(key, language, allow_missing = FALSE)
Method edit()
Usage
i18n_dict$edit(key, language, new)
Method print()
Usage
i18n_dict$print(...)
Method clone()
The objects of this class are cloneable with this method.
Usage
i18n_dict$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.