Global i18n config list.

Description

Global i18n config list.

Usage

.i18_config

Format

An object of class list of length 3.

onLoad

Description

On package load it updates .i18_config reading yaml file from config.

Usage

.onLoad(libname, pkgname)

Arguments

Translator options

Description

Translator options

Usage

.translator_options

Format

An object of class list of length 3.

Translator R6 Class

Description

Translator R6 Class

Translator R6 Class

Details

This creates shinny.i18n Translator object used for translations. Now you can surround the pieces of the text you want to translate by one of the translate statements (ex.: Translator$t("translate me")). Find details in method descriptions below.

Methods

Public methods

• Translator$new()

• Translator$get_languages()

• Translator$get_translations()

• Translator$get_key_translation()

• Translator$get_translation_language()

• Translator$translate()

• Translator$t()

• Translator$set_translation_language()

• Translator$parse_date()

• Translator$parse_number()

• Translator$automatic_translate()

• Translator$at()

• Translator$use_js()

• Translator$clone()

Method new()

Initialize the Translator with data

Usage

Translator$new(
  translation_csvs_path = NULL,
  translation_json_path = NULL,
  translation_csv_config = NULL,
  separator_csv = ",",
  automatic = FALSE
)

Arguments

Method get_languages()

Get all available languages

Usage

Translator$get_languages()

Method get_translations()

Get whole translation matrix

Usage

Translator$get_translations()

Method get_key_translation()

Get active key translation

Usage

Translator$get_key_translation()

Method get_translation_language()

Get current target translation language

Usage

Translator$get_translation_language()

Method translate()

Translates 'keyword' to language specified by 'set_translation_language'

Usage

Translator$translate(keyword, session = shiny::getDefaultReactiveDomain())

Arguments

Method t()

Wrapper to translate method.

Usage

Translator$t(keyword, session = shiny::getDefaultReactiveDomain())

Arguments

Method set_translation_language()

Specify language of translation. It must exist in 'languages' field.

Usage

Translator$set_translation_language(transl_language)

Arguments

Method parse_date()

Parse date to format described in 'cultural_date_format' field in config.

Usage

Translator$parse_date(date)

Arguments

Method parse_number()

Numbers parser. Not implemented yet.

Usage

Translator$parse_number(number)

Arguments

Returns

character with number formatting

Method automatic_translate()

Translates 'keyword' to language specified by 'set_translation_language' using cloud service 'api'. You need to set API settings first.

Usage

Translator$automatic_translate(keyword, api = "google")

Arguments

Method at()

Wrapper to automatic_translate method

Usage

Translator$at(keyword, api = "google")

Arguments

Method use_js()

Call to wrap translation in span object. Used for browser-side translations.

Usage

Translator$use_js()

Method clone()

The objects of this class are cloneable with this method.

Usage

Translator$clone(deep = FALSE)

Arguments

Examples

## Not run: 
  i18n <- Translator$new(translation_json_path = "translation.json") # translation file
  i18n$set_translation_language("it")
  i18n$t("This text will be translated to Italian")

## End(Not run)

# Shiny example
if (interactive()) {
library(shiny)
library(shiny.i18n)
 #to run this example  make sure that you have a translation file
 #in the same path
i18n <- Translator$new(translation_json_path = "examples/data/translation.json")
i18n$set_translation_language("pl")
ui <- fluidPage(
  h2(i18n$t("Hello Shiny!"))
)
server <- function(input, output) {}
shinyApp(ui = ui, server = server)
}

Check for value presence

Description

If value is not present in vector it takes its first value.

Usage

check_value_presence(val, vect, warn_msg = "")

Arguments

Value

updated val

Column to row

Description

Returns the same data.frame where one column is a rowname now.

Usage

column_to_row(data, colname)

Arguments

Value

data.frame with one column less

Create translation file addin

Description

Create translation file addin

Usage

create_translation_addin()

Create translation file

Description

Auxiliary shiny.i18n function that searches for all key expressions (e.g. surrounded by i18n$t() tag in the script).

Usage

create_translation_file(path, type = "json", handle = "i18n", output = NULL)

Arguments

Extract key expressions

Description

Extract key expressions

Usage

extract_key_expressions(text, handle = "i18n")

Arguments

Value

vector of characters with key expressions

Get i18n config

Description

Get i18n config

Usage

get_i18n_config(field)

Arguments

Value

character with option from config.yaml file

Create i18n state div

Description

This hidden div contain information about i18 translation state.

Usage

i18n_state(init_language)

Arguments

Value

shiny tag with div "i18n-state"

Creates new i18n Translator object

Description

Creates new i18n Translator object

Usage

init_i18n(
  translation_csvs_path = NULL,
  translation_json_path = NULL,
  translation_csv_config = NULL,
  automatic = FALSE
)

Arguments

Value

i18n object

Examples

## Not run: 
 i18n <- init_i18n(translation_csvs_path = "../csvdata/")
 i18n <- init_i18n(translation_json_path = "translations.json")

## End(Not run)

Load Local YAML Config

Description

Load Local YAML Config

Usage

load_local_config(yaml_config_path)

Arguments

Value

list of config options or empty list if file not exists

Multiple Merge

Description

Inspired by: https://www.r-bloggers.com/merging-multiple-data-files-into-one-data-frame/

Usage

multmerge(filenames, sep = ",")

Arguments

Value

data.frame with merged files

Read and merge CSVs

Description

This function reads and merges data from multiple csv files in given folder.

Usage

read_and_merge_csvs(dir_path, sep = ",")

Arguments

Value

data.frame with CSV files content

Save example i18n file to CSV

Description

It saves translation data structure with language key code "key" and language to translate name "lang" as an example of a translation csv file.

Usage

save_to_csv(key_expressions, output_path = NULL)

Arguments

Save example i18n file to json

Description

It saves translation data structure with language key code "key" as an example of a translation JSON file.

Usage

save_to_json(key_expressions, output_path = NULL)

Arguments

This provides functions for automatic translations with online APIs Translate with Google cloud

Description

This is wrapper for gl_translate function from googleLanguageR package.

Usage

translate_with_google_cloud(txt_to_translate, target_lang)

Arguments

Update language (i18n) in UI

Description

It sends a message to session object to update the language in UI elements.

Usage

update_lang(language, session = shiny::getDefaultReactiveDomain())

Arguments

See Also

usei18n

Use i18n in UI

Description

This is an auxiliary function needed to monitor the state of the UI for live language translations.

Usage

usei18n(translator)

Arguments

Examples

if (interactive()) {
  library(shiny)
  library(shiny.i18n)
  # for this example to run make sure that you have a translation file
  # in the same path
  i18n <- Translator$new(translation_json_path = "translation.json")
  i18n$set_translation_language("en")

  ui <- fluidPage(
    usei18n(i18n),
    actionButton("go", "GO!"),
    h2(i18n$t("Hello Shiny!"))
  )

  server <- shinyServer(function(input, output, session) {
    observeEvent(input$go,{
      update_lang(session, "pl")
    })
  })

  shinyApp(ui = ui, server = server)
}

Validate Column Names

Description

Validate if n-th column name of data.frames (given in list) is the same.

Usage

validate_names(list_df, n = 1)

Arguments

Value

TRUE if names of n-th columns of data.frames is the same, FALSE otherwise.