View source: R/get_message_data.R
get_message_data | R Documentation |
This function looks in the R and src directories of a package for
user-visible messages and compiles them as a
data.table::data.table()
to facilitate
analyzing this corpus as such.
get_message_data(
dir = ".",
custom_translation_functions = list(R = NULL, src = NULL),
style = NULL,
verbose = !is_testing()
)
dir |
Character, default the present directory; a directory in which an R package is stored. |
custom_translation_functions |
A See Details in |
style |
Translation style, either Both styles extract strings explicitly flagged for translation with
|
verbose |
Logical, default |
A data.table
with the following schema:
message_source
: character
, either "R"
or "src"
,
saying whether the string was found in the R or the src folder of the
package
type
: character
, either "singular"
or
"plural"
; "plural"
means the string came from
ngettext()
and can be pluralized
file
: character
, the file where the string was found
msgid
: character
, the string (character literal or char
array as
found in the source); missing for all type == "plural"
strings
msgid_plural
: list(character, character)
, the strings
(character literals or char
arrays as found in the source); the first
applies in English for n=1
(see ngettext
), while the second
applies for n!=1
; missing for all type == "singular"
strings
call
: character
, the full call containing the string
that was found
line_number
: integer
, the line in file
where the string was found
is_repeat
: logical
, whether the msgid
is a duplicate within this
message_source
is_marked_for_translation
:logical
, whether the string is marked for
translation (e.g., in R, all character literals supplied to a ...
argument in
stop()
are so marked)
is_templated
, logical
, whether the string is templatable (e.g., uses
%s
or other formatting markers)
Michael Chirico
translate_package()
,
write_po_file()
pkg <- system.file('pkg', package = 'potools')
get_message_data(pkg)
# includes strings provided to the custom R wrapper function catf()
get_message_data(pkg, custom_translation_functions = list(R = "catf:fmt|1"))
# includes untranslated strings provided to the custom
# C/C++ wrapper function ReverseTemplateMessage()
get_message_data(
pkg,
custom_translation_functions = list(src = "ReverseTemplateMessage:2")
)
# cleanup
rm(pkg)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.