AMR/docs/reference/translate.html

332 lines
15 KiB
HTML
Raw Normal View History

2019-05-10 16:44:59 +02:00
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Translate Strings from AMR Package — translate • AMR (for R)</title>
2019-05-10 16:44:59 +02:00
<!-- favicons -->
<link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png">
<link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png">
<link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png" />
<link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png" />
<link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png" />
<link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png" />
2019-10-13 09:31:58 +02:00
2019-05-10 16:44:59 +02:00
<!-- jquery -->
2020-04-13 21:09:56 +02:00
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
2019-05-10 16:44:59 +02:00
<!-- Bootstrap -->
2020-12-27 00:07:00 +01:00
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/flatly/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" />
2019-10-13 09:31:58 +02:00
2020-12-21 22:46:29 +01:00
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script>
2020-12-21 22:46:29 +01:00
2020-04-17 19:16:30 +02:00
<!-- bootstrap-toc -->
<link rel="stylesheet" href="../bootstrap-toc.css">
<script src="../bootstrap-toc.js"></script>
2019-05-10 16:44:59 +02:00
<!-- Font Awesome icons -->
2020-04-17 19:16:30 +02:00
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous" />
2019-05-10 16:44:59 +02:00
<!-- clipboard.js -->
2020-04-17 19:16:30 +02:00
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script>
2019-05-10 16:44:59 +02:00
2019-10-13 09:31:58 +02:00
<!-- headroom.js -->
2020-04-17 19:16:30 +02:00
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>
2019-05-10 16:44:59 +02:00
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>
<link href="../extra.css" rel="stylesheet">
<script src="../extra.js"></script>
<meta property="og:title" content="Translate Strings from AMR Package — translate" />
2020-05-16 13:05:47 +02:00
<meta property="og:description" content="For language-dependent output of AMR functions, like mo_name(), mo_gramstain(), mo_type() and ab_name()." />
<meta property="og:image" content="https://msberends.github.io/AMR/logo.png" />
2019-05-10 16:44:59 +02:00
2019-10-13 09:31:58 +02:00
2019-05-10 16:44:59 +02:00
<!-- mathjax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
2019-10-13 09:31:58 +02:00
2019-05-10 16:44:59 +02:00
</head>
2020-04-17 19:16:30 +02:00
<body data-spy="scroll" data-target="#toc">
2019-05-10 16:44:59 +02:00
<div class="container template-reference-topic">
<header>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">AMR (for R)</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">1.5.0.9016</span>
2019-05-10 16:44:59 +02:00
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
2020-12-17 16:22:25 +01:00
<span class="fas fa-home"></span>
2019-05-10 16:44:59 +02:00
Home
</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
2020-12-17 16:22:25 +01:00
<span class="fas fa-question-circle"></span>
2019-05-10 16:44:59 +02:00
How to
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="../articles/AMR.html">
2020-12-17 16:22:25 +01:00
<span class="fas fa-directions"></span>
2019-05-10 16:44:59 +02:00
Conduct AMR analysis
</a>
</li>
<li>
<a href="../articles/resistance_predict.html">
2020-12-17 16:22:25 +01:00
<span class="fas fa-dice"></span>
2019-05-10 16:44:59 +02:00
Predict antimicrobial resistance
</a>
</li>
2020-08-21 11:40:13 +02:00
<li>
<a href="../articles/datasets.html">
2020-12-17 16:22:25 +01:00
<span class="fas fa-database"></span>
2020-08-21 11:40:13 +02:00
Data sets for download / own use
2020-08-21 11:40:13 +02:00
</a>
</li>
2020-04-13 21:09:56 +02:00
<li>
<a href="../articles/PCA.html">
2020-12-17 16:22:25 +01:00
<span class="fas fa-compress"></span>
2020-04-13 21:09:56 +02:00
Conduct principal component analysis for AMR
</a>
</li>
2019-05-28 16:50:40 +02:00
<li>
<a href="../articles/MDR.html">
2020-12-17 16:22:25 +01:00
<span class="fas fa-skull-crossbones"></span>
2019-05-28 16:50:40 +02:00
Determine multi-drug resistance (MDR)
</a>
</li>
2019-05-10 16:44:59 +02:00
<li>
<a href="../articles/WHONET.html">
2020-12-17 16:22:25 +01:00
<span class="fas fa-globe-americas"></span>
2019-05-10 16:44:59 +02:00
Work with WHONET data
</a>
</li>
<li>
<a href="../articles/SPSS.html">
2020-12-17 16:22:25 +01:00
<span class="fas fa-file-upload"></span>
2019-05-10 16:44:59 +02:00
Import data from SPSS/SAS/Stata
</a>
</li>
<li>
<a href="../articles/EUCAST.html">
2020-12-17 16:22:25 +01:00
<span class="fas fa-exchange-alt"></span>
2019-05-10 16:44:59 +02:00
Apply EUCAST rules
</a>
</li>
<li>
<a href="../reference/mo_property.html">
2020-12-17 16:22:25 +01:00
<span class="fas fa-bug"></span>
2019-05-10 16:44:59 +02:00
Get properties of a microorganism
</a>
</li>
<li>
<a href="../reference/ab_property.html">
2020-12-17 16:22:25 +01:00
<span class="fas fa-capsules"></span>
2019-05-10 16:44:59 +02:00
Get properties of an antibiotic
</a>
</li>
<li>
<a href="../articles/benchmarks.html">
2020-12-17 16:22:25 +01:00
<span class="fas fa-shipping-fast"></span>
2019-05-10 16:44:59 +02:00
Other: benchmarks
</a>
</li>
</ul>
</li>
<li>
2020-07-28 18:39:57 +02:00
<a href="../reference/index.html">
2020-12-17 16:22:25 +01:00
<span class="fas fa-book-open"></span>
2019-05-10 16:44:59 +02:00
Manual
</a>
</li>
<li>
<a href="../authors.html">
2020-12-17 16:22:25 +01:00
<span class="fas fa-users"></span>
2019-05-10 16:44:59 +02:00
Authors
</a>
</li>
<li>
2020-07-28 18:39:57 +02:00
<a href="../news/index.html">
2020-12-17 16:22:25 +01:00
<span class="far fa-newspaper"></span>
2019-05-10 16:44:59 +02:00
Changelog
</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
2020-07-08 14:48:06 +02:00
<a href="https://github.com/msberends/AMR">
2020-12-17 16:22:25 +01:00
<span class="fab fa-github"></span>
2019-05-10 16:44:59 +02:00
Source Code
</a>
</li>
<li>
2020-07-28 18:39:57 +02:00
<a href="../survey.html">
2020-12-17 16:22:25 +01:00
<span class="fas fa-clipboard-list"></span>
2019-05-10 16:44:59 +02:00
2020-07-28 18:39:57 +02:00
Survey
2019-05-10 16:44:59 +02:00
</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
2019-10-13 09:31:58 +02:00
2019-05-10 16:44:59 +02:00
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Translate Strings from AMR Package</h1>
2020-07-08 14:48:06 +02:00
<small class="dont-index">Source: <a href='https://github.com/msberends/AMR/blob/master/R/translate.R'><code>R/translate.R</code></a></small>
2019-05-10 16:44:59 +02:00
<div class="hidden name"><code>translate.Rd</code></div>
</div>
<div class="ref-description">
2020-05-16 13:05:47 +02:00
<p>For language-dependent output of AMR functions, like <code><a href='mo_property.html'>mo_name()</a></code>, <code><a href='mo_property.html'>mo_gramstain()</a></code>, <code><a href='mo_property.html'>mo_type()</a></code> and <code><a href='ab_property.html'>ab_name()</a></code>.</p>
2019-05-10 16:44:59 +02:00
</div>
<pre class="usage"><span class='fu'>get_locale</span><span class='op'>(</span><span class='op'>)</span></pre>
2019-10-13 09:31:58 +02:00
2019-05-10 16:44:59 +02:00
<h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>
2020-12-17 16:22:25 +01:00
<p>Strings will be translated to foreign languages if they are defined in a local translation file. Additions to this file can be suggested at our repository. The file can be found here: <a href='https://github.com/msberends/AMR/blob/master/data-raw/translations.tsv'>https://github.com/msberends/AMR/blob/master/data-raw/translations.tsv</a>. This file will be read by all functions where a translated output can be desired, like all <code><a href='mo_property.html'>mo_*</a></code> functions (such as <code><a href='mo_property.html'>mo_name()</a></code>, <code><a href='mo_property.html'>mo_gramstain()</a></code>, <code><a href='mo_property.html'>mo_type()</a></code>, etc.) and <code><a href='ab_property.html'>ab_*</a></code> functions (such as <code><a href='ab_property.html'>ab_name()</a></code>, <code><a href='ab_property.html'>ab_group()</a></code>, etc.).</p>
<p>Currently supported languages are: Dutch, English, French, German, Italian, Portuguese and Spanish. Please note that currently not all these languages have translations available for all antimicrobial agents and colloquial microorganism names.</p>
<p>Please suggest your own translations <a href='https://github.com/msberends/AMR/issues/new?title=Translations'>by creating a new issue on our repository</a>.</p><h3 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>Changing the Default Language</h3>
2020-09-14 12:21:23 +02:00
<p>The system language will be used at default (as returned by <code><a href='https://rdrr.io/r/base/Sys.getenv.html'>Sys.getenv("LANG")</a></code> or, if <code>LANG</code> is not set, <code><a href='https://rdrr.io/r/base/locales.html'>Sys.getlocale()</a></code>), if that language is supported. But the language to be used can be overwritten in two ways and will be checked in this order:</p><ol>
2020-09-14 12:21:23 +02:00
<li><p>Setting the R option <code>AMR_locale</code>, e.g. by running <code><a href='https://rdrr.io/r/base/options.html'>options(AMR_locale = "de")</a></code></p></li>
<li><p>Setting the system variable <code>LANGUAGE</code> or <code>LANG</code>, e.g. by adding <code>LANGUAGE="de_DE.utf8"</code> to your <code>.Renviron</code> file in your home directory</p></li>
</ol>
<p>So if the R option <code>AMR_locale</code> is set, the system variables <code>LANGUAGE</code> and <code>LANG</code> will be ignored.</p>
<h2 class="hasAnchor" id="stable-lifecycle"><a class="anchor" href="#stable-lifecycle"></a>Stable Lifecycle</h2>
<p><img src='figures/lifecycle_stable.svg' style=margin-bottom:5px /> <br />
The <a href='lifecycle.html'>lifecycle</a> of this function is <strong>stable</strong>. In a stable function, major changes are unlikely. This means that the unlying code will generally evolve by adding new arguments; removing arguments or changing the meaning of existing arguments will be avoided.</p>
2020-12-22 00:51:17 +01:00
<p>If the unlying code needs breaking changes, they will occur gradually. For example, a argument will be deprecated and first continue to work, but will emit an message informing you of the change. Next, typically after at least one newly released version on CRAN, the message will be transformed to an error.</p>
<h2 class="hasAnchor" id="read-more-on-our-website-"><a class="anchor" href="#read-more-on-our-website-"></a>Read more on Our Website!</h2>
2019-05-10 16:44:59 +02:00
2019-10-13 09:31:58 +02:00
<p>On our website <a href='https://msberends.github.io/AMR/'>https://msberends.github.io/AMR/</a> you can find <a href='https://msberends.github.io/AMR/articles/AMR.html'>a comprehensive tutorial</a> about how to conduct AMR data analysis, the <a href='https://msberends.github.io/AMR/reference/'>complete documentation of all functions</a> and <a href='https://msberends.github.io/AMR/articles/WHONET.html'>an example analysis using WHONET data</a>. As we would like to better understand the backgrounds and needs of our users, please <a href='https://msberends.github.io/AMR/survey.html'>participate in our survey</a>!</p>
2019-05-10 16:44:59 +02:00
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
2020-12-22 00:51:17 +01:00
<pre class="examples"><span class='co'># The 'language' argument of below functions</span>
2019-05-10 16:44:59 +02:00
<span class='co'># will be set automatically to your system language</span>
<span class='co'># with get_locale()</span>
<span class='co'># English</span>
<span class='fu'><a href='mo_property.html'>mo_name</a></span><span class='op'>(</span><span class='st'>"CoNS"</span>, language <span class='op'>=</span> <span class='st'>"en"</span><span class='op'>)</span>
2019-05-10 16:44:59 +02:00
<span class='co'>#&gt; "Coagulase-negative Staphylococcus (CoNS)"</span>
<span class='co'># German</span>
<span class='fu'><a href='mo_property.html'>mo_name</a></span><span class='op'>(</span><span class='st'>"CoNS"</span>, language <span class='op'>=</span> <span class='st'>"de"</span><span class='op'>)</span>
2019-05-10 16:44:59 +02:00
<span class='co'>#&gt; "Koagulase-negative Staphylococcus (KNS)"</span>
<span class='co'># Dutch</span>
<span class='fu'><a href='mo_property.html'>mo_name</a></span><span class='op'>(</span><span class='st'>"CoNS"</span>, language <span class='op'>=</span> <span class='st'>"nl"</span><span class='op'>)</span>
2019-05-10 16:44:59 +02:00
<span class='co'>#&gt; "Coagulase-negatieve Staphylococcus (CNS)"</span>
<span class='co'># Spanish</span>
<span class='fu'><a href='mo_property.html'>mo_name</a></span><span class='op'>(</span><span class='st'>"CoNS"</span>, language <span class='op'>=</span> <span class='st'>"es"</span><span class='op'>)</span>
2019-05-10 16:44:59 +02:00
<span class='co'>#&gt; "Staphylococcus coagulasa negativo (SCN)"</span>
<span class='co'># Italian</span>
<span class='fu'><a href='mo_property.html'>mo_name</a></span><span class='op'>(</span><span class='st'>"CoNS"</span>, language <span class='op'>=</span> <span class='st'>"it"</span><span class='op'>)</span>
2019-05-10 16:44:59 +02:00
<span class='co'>#&gt; "Staphylococcus negativo coagulasi (CoNS)"</span>
<span class='co'># Portuguese</span>
<span class='fu'><a href='mo_property.html'>mo_name</a></span><span class='op'>(</span><span class='st'>"CoNS"</span>, language <span class='op'>=</span> <span class='st'>"pt"</span><span class='op'>)</span>
<span class='co'>#&gt; "Staphylococcus coagulase negativo (CoNS)"</span>
</pre>
2019-05-10 16:44:59 +02:00
</div>
2020-04-13 21:09:56 +02:00
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
2020-04-17 19:16:30 +02:00
<nav id="toc" data-toggle="toc" class="sticky-top">
<h2 data-toc-skip>Contents</h2>
</nav>
2019-05-10 16:44:59 +02:00
</div>
</div>
2019-10-13 09:31:58 +02:00
2019-05-10 16:44:59 +02:00
<footer>
<div class="copyright">
2020-01-26 20:38:54 +01:00
<p>Developed by <a href='https://www.rug.nl/staff/m.s.berends/'>Matthijs S. Berends</a>, <a href='https://www.rug.nl/staff/c.f.luz/'>Christian F. Luz</a>, <a href='https://www.rug.nl/staff/a.w.friedrich/'>Alexander W. Friedrich</a>, <a href='https://www.rug.nl/staff/b.sinha/'>Bhanu N. M. Sinha</a>, <a href='https://www.rug.nl/staff/c.j.albers/'>Casper J. Albers</a>, <a href='https://www.rug.nl/staff/c.glasner/'>Corinna Glasner</a>.</p>
2019-05-10 16:44:59 +02:00
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p>
2019-05-10 16:44:59 +02:00
</div>
2019-10-13 09:31:58 +02:00
2019-05-10 16:44:59 +02:00
</footer>
</div>
2019-10-13 09:31:58 +02:00
2019-05-10 16:44:59 +02:00
</body>
</html>
2019-10-13 09:31:58 +02:00