shiny.i18n v0.1.0

0

Monthly downloads

0th

Percentile

Shiny Applications Internationalization

It provides easy internationalization of Shiny applications. It can be used as standalone translation package to translate reports, interactive visualizations or graphical elements as well.

Readme

shiny.i18n

Shiny applications internationalisation made easy!

Actually, you can use shiny.i18n as a standalone R package - shiny app is just a perfect usecase example.

Using it is very simple: just prepare your translation files in one of the supported formats, read them into your app using user-friendly shiny.i18n interface and surround your expressions to translate by a translator tag. Thanks to that your app will remain neat and readible.

For more informations check the Example section below!

Change languages and formats easy with shiny.i18n.

Source code

This library source code can be found on Appsilon Data Science's Github:
https://github.com/Appsilon/shiny.i18n/

How to install?

Note! This library is still in its infancy. Api might change in the future.

At the moment it's possible to install this library through devtools.

devtools::install_github("Appsilon/shiny.i18n")

To install previous version you can run:

devtools::install_github("Appsilon/shiny.i18n", ref = "0.1.0")

Example

You can find some basic examples in /inst/examples.

Translation file format

Currently shiny.i18n supports two formats:

  • csv - where each translation is in separate file translation_<LANGUAGE-CODE>.csv. Example of translation_pl.csv for Polish language you may find here: inst/examples/data/translation_pl.csv.

  • json - single file translation.json with mandatory fields: "languages" with list of all language codes and "translation" with list of dictionaries assigning each translation to a language code. Example of such a json file for Polish language you may find here: inst/examples/data/translation.json.

How to contribute?

If you want to contribute to this project please submit a regular PR, once you're done with new feature or bug fix.

Changes in documentation

Both repository README.md file and an official documentation page are generated with Rmarkdown, so if there is a need to update them, please modify accordingly a README.Rmd file and run a build_readme.R script to compile it.

Troubleshooting

We used the latest versions of dependencies for this library, so please update your R environment before installation.

Future enhacements

  • CRAN release
  • Format numeric data

Appsilon Data Science

Get in touch dev@appsilondatascience.com

Functions in shiny.i18n

Name Description
translator Translator class
get_i18n_config Get i18n config
validate_names Validate Column Names
load_local_config Load Local YAML Config
multmerge Mulitple Merge
read_and_merge_csvs Read and merge CSVs
check_value_presence Check for value presence
column_to_row Column to row
No Results!

Last month downloads

Details

License MIT + file LICENSE
Encoding UTF-8
LazyData true
URL http://github.com/Appsilon/shiny.i18n
BugReports http://github.com/Appsilon/shiny.i18n/issues
RoxygenNote 6.0.1
NeedsCompilation no
Packaged 2018-09-03 09:50:25 UTC; dominik
Repository CRAN
Date/Publication 2018-09-13 16:50:03 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/shiny.i18n)](http://www.rdocumentation.org/packages/shiny.i18n)