mirror of
https://github.com/msberends/AMR.git
synced 2024-12-26 18:46:13 +01:00
243 lines
20 KiB
HTML
243 lines
20 KiB
HTML
<!DOCTYPE html>
|
||
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="For language-dependent output of AMR functions, like mo_name(), mo_gramstain(), mo_type() and ab_name()."><title>Translate Strings from the AMR Package — translate • AMR (for R)</title><!-- 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"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.1.3/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.1.3/bootstrap.bundle.min.js"></script><link href="../deps/Fira_Code-0.4.2/font.css" rel="stylesheet"><!-- Font Awesome icons --><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"><!-- bootstrap-toc --><script src="https://cdn.rawgit.com/afeld/bootstrap-toc/v1.0.1/dist/bootstrap-toc.min.js"></script><!-- headroom.js --><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><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><script src="../extra.js"></script><meta property="og:title" content="Translate Strings from the AMR Package — translate"><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.svg"><meta name="twitter:card" content="summary_large_image"><meta name="twitter:creator" content="@msberends"><meta name="twitter:site" content="@msberends"><!-- 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]--></head><body>
|
||
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
||
|
||
|
||
<nav class="navbar fixed-top navbar-dark navbar-expand-lg bg-primary"><div class="container">
|
||
|
||
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
|
||
|
||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">1.8.2.9021</small>
|
||
|
||
|
||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||
<span class="navbar-toggler-icon"></span>
|
||
</button>
|
||
|
||
<div id="navbar" class="collapse navbar-collapse ms-3">
|
||
<ul class="navbar-nav me-auto"><li class="nav-item">
|
||
<a class="nav-link" href="../index.html">
|
||
<span class="fa fa-home"></span>
|
||
|
||
Home
|
||
</a>
|
||
</li>
|
||
<li class="nav-item dropdown">
|
||
<a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown" role="button" aria-expanded="false" aria-haspopup="true" id="dropdown--how-to">
|
||
<span class="fa fa-question-circle"></span>
|
||
|
||
How to
|
||
</a>
|
||
<div class="dropdown-menu" aria-labelledby="dropdown--how-to">
|
||
<a class="dropdown-item" href="../articles/AMR.html">
|
||
<span class="fa fa-directions"></span>
|
||
|
||
Conduct AMR analysis
|
||
</a>
|
||
<a class="dropdown-item" href="../articles/resistance_predict.html">
|
||
<span class="fa fa-dice"></span>
|
||
|
||
Predict antimicrobial resistance
|
||
</a>
|
||
<a class="dropdown-item" href="../articles/datasets.html">
|
||
<span class="fa fa-database"></span>
|
||
|
||
Data sets for download / own use
|
||
</a>
|
||
<a class="dropdown-item" href="../articles/PCA.html">
|
||
<span class="fa fa-compress"></span>
|
||
|
||
Conduct principal component analysis for AMR
|
||
</a>
|
||
<a class="dropdown-item" href="../articles/MDR.html">
|
||
<span class="fa fa-skull-crossbones"></span>
|
||
|
||
Determine multi-drug resistance (MDR)
|
||
</a>
|
||
<a class="dropdown-item" href="../articles/WHONET.html">
|
||
<span class="fa fa-globe-americas"></span>
|
||
|
||
Work with WHONET data
|
||
</a>
|
||
<a class="dropdown-item" href="../articles/SPSS.html">
|
||
<span class="fa fa-file-upload"></span>
|
||
|
||
Import data from SPSS/SAS/Stata
|
||
</a>
|
||
<a class="dropdown-item" href="../articles/EUCAST.html">
|
||
<span class="fa fa-exchange-alt"></span>
|
||
|
||
Apply EUCAST rules
|
||
</a>
|
||
<a class="dropdown-item" href="../reference/mo_property.html">
|
||
<span class="fa fa-bug"></span>
|
||
|
||
Get properties of a microorganism
|
||
</a>
|
||
<a class="dropdown-item" href="../reference/ab_property.html">
|
||
<span class="fa fa-capsules"></span>
|
||
|
||
Get properties of an antibiotic
|
||
</a>
|
||
</div>
|
||
</li>
|
||
<li class="active nav-item">
|
||
<a class="nav-link" href="../reference/index.html">
|
||
<span class="fa fa-book-open"></span>
|
||
|
||
Manual
|
||
</a>
|
||
</li>
|
||
<li class="nav-item">
|
||
<a class="nav-link" href="../authors.html">
|
||
<span class="fa fa-users"></span>
|
||
|
||
Authors
|
||
</a>
|
||
</li>
|
||
<li class="nav-item">
|
||
<a class="nav-link" href="../news/index.html">
|
||
<span class="far fa far fa-newspaper"></span>
|
||
|
||
Changelog
|
||
</a>
|
||
</li>
|
||
</ul><form class="form-inline my-2 my-lg-0" role="search">
|
||
<input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form>
|
||
|
||
<ul class="navbar-nav"><li class="nav-item">
|
||
<a class="external-link nav-link" href="https://github.com/msberends/AMR">
|
||
<span class="fab fa fab fa-github"></span>
|
||
|
||
Source Code
|
||
</a>
|
||
</li>
|
||
</ul></div>
|
||
|
||
|
||
</div>
|
||
</nav><div class="container template-reference-topic">
|
||
<div class="row">
|
||
<main id="main" class="col-md-9"><div class="page-header">
|
||
<img src="../logo.svg" class="logo" alt=""><h1>Translate Strings from the AMR Package</h1>
|
||
<small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/HEAD/R/translate.R" class="external-link"><code>R/translate.R</code></a></small>
|
||
<div class="d-none name"><code>translate.Rd</code></div>
|
||
</div>
|
||
|
||
<div class="ref-description section level2">
|
||
<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>
|
||
</div>
|
||
|
||
<div class="section level2">
|
||
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
|
||
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">get_AMR_locale</span><span class="op">(</span><span class="op">)</span></span>
|
||
<span></span>
|
||
<span><span class="fu">set_AMR_locale</span><span class="op">(</span><span class="va">language</span><span class="op">)</span></span>
|
||
<span></span>
|
||
<span><span class="fu">reset_AMR_locale</span><span class="op">(</span><span class="op">)</span></span>
|
||
<span></span>
|
||
<span><span class="fu">translate_AMR</span><span class="op">(</span><span class="va">x</span>, language <span class="op">=</span> <span class="fu">get_AMR_locale</span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span></code></pre></div>
|
||
</div>
|
||
|
||
<div class="section level2">
|
||
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
||
<dl><dt>language</dt>
|
||
<dd><p>language to choose. Use one of these supported language names or ISO-639-1 codes: English (en), Chinese (zh), Danish (da), Dutch (nl), French (fr), German (de), Greek (el), Italian (it), Japanese (ja), Polish (pl), Portuguese (pt), Russian (ru), Spanish (es), Swedish (sv), Turkish (tr) or Ukrainian (uk).</p></dd>
|
||
|
||
|
||
<dt>x</dt>
|
||
<dd><p>text to translate</p></dd>
|
||
|
||
</dl></div>
|
||
<div class="section level2">
|
||
<h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
|
||
<p>The currently 16 supported languages are English (en), Chinese (zh), Danish (da), Dutch (nl), French (fr), German (de), Greek (el), Italian (it), Japanese (ja), Polish (pl), Portuguese (pt), Russian (ru), Spanish (es), Swedish (sv), Turkish (tr) or Ukrainian (uk). All these languages have translations available for all antimicrobial agents and colloquial microorganism names.</p>
|
||
<p><strong>To silence language notes when this package loads</strong> on a non-English operating system, you can set the option <code>AMR_locale</code> in your <code>.Rprofile</code> file like this:</p>
|
||
<p></p><div class="sourceCode r"><pre><code><span><span class="co"># Open .Rprofile file</span></span>
|
||
<span><span class="fu">utils</span><span class="fu">::</span><span class="fu"><a href="https://rdrr.io/r/utils/file.edit.html" class="external-link">file.edit</a></span><span class="op">(</span><span class="st">"~/.Rprofile"</span><span class="op">)</span></span>
|
||
<span></span>
|
||
<span><span class="co"># Add e.g. Italian support to that file using:</span></span>
|
||
<span><span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">options</a></span><span class="op">(</span>AMR_locale <span class="op">=</span> <span class="st">"Italian"</span><span class="op">)</span></span></code></pre><p></p></div>
|
||
<p>And then save the file.</p>
|
||
<p>Please read about adding or updating a language in <a href="https://github.com/msberends/AMR/wiki/" class="external-link">our Wiki</a>.</p><div class="section">
|
||
<h3 id="changing-the-default-language">Changing the Default Language<a class="anchor" aria-label="anchor" href="#changing-the-default-language"></a></h3>
|
||
|
||
|
||
<p>The system language will be used at default (as returned by <code>Sys.getenv("LANG")</code> or, if <code>LANG</code> is not set, <code><a href="https://rdrr.io/r/base/locales.html" class="external-link">Sys.getlocale("LC_COLLATE")</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><li><p>Setting the R option <code>AMR_locale</code>, either by using e.g. <code>set_AMR_locale("German")</code> or by running e.g. <code>options(AMR_locale = "German")</code>.</p>
|
||
<p>Note that setting an <span style="R">R</span> option only works in the same session. Save the command <code>options(AMR_locale = "(your language)")</code> to your <code>.Rprofile</code> file to apply it for every session. Run <code>utils::file.edit("~/.Rprofile")</code> to edit your <code>.Rprofile</code> file.</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>Thus, if the R option <code>AMR_locale</code> is set, the system variables <code>LANGUAGE</code> and <code>LANG</code> will be ignored.</p>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="section level2">
|
||
<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
|
||
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co"># Current settings (based on system language)</span></span></span>
|
||
<span class="r-in"><span><span class="fu"><a href="ab_property.html">ab_name</a></span><span class="op">(</span><span class="st">"Ciprofloxacin"</span><span class="op">)</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> [1] "Ciprofloxacin"</span>
|
||
<span class="r-in"><span><span class="fu"><a href="mo_property.html">mo_name</a></span><span class="op">(</span><span class="st">"Coagulase-negative Staphylococcus (CoNS)"</span><span class="op">)</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> [1] "Coagulase-negative Staphylococcus (CoNS)"</span>
|
||
<span class="r-in"><span></span></span>
|
||
<span class="r-in"><span><span class="co"># setting another language</span></span></span>
|
||
<span class="r-in"><span><span class="fu">set_AMR_locale</span><span class="op">(</span><span class="st">"Spanish"</span><span class="op">)</span></span></span>
|
||
<span class="r-msg co"><span class="r-pr">#></span> ℹ Using Spanish (Español) for the AMR package for this session.</span>
|
||
<span class="r-in"><span><span class="fu"><a href="ab_property.html">ab_name</a></span><span class="op">(</span><span class="st">"Ciprofloxacin"</span><span class="op">)</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> [1] "Ciprofloxacina"</span>
|
||
<span class="r-in"><span><span class="fu"><a href="mo_property.html">mo_name</a></span><span class="op">(</span><span class="st">"Coagulase-negative Staphylococcus (CoNS)"</span><span class="op">)</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> [1] "Staphylococcus coagulasa negativo (SCN)"</span>
|
||
<span class="r-in"><span></span></span>
|
||
<span class="r-in"><span><span class="co"># setting yet another language</span></span></span>
|
||
<span class="r-in"><span><span class="fu">set_AMR_locale</span><span class="op">(</span><span class="st">"Greek"</span><span class="op">)</span></span></span>
|
||
<span class="r-msg co"><span class="r-pr">#></span> ℹ Using Greek (Ελληνικά) for the AMR package for this session.</span>
|
||
<span class="r-in"><span><span class="fu"><a href="ab_property.html">ab_name</a></span><span class="op">(</span><span class="st">"Ciprofloxacin"</span><span class="op">)</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> [1] "Σιπροφλοξασίνη"</span>
|
||
<span class="r-in"><span><span class="fu"><a href="mo_property.html">mo_name</a></span><span class="op">(</span><span class="st">"Coagulase-negative Staphylococcus (CoNS)"</span><span class="op">)</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> [1] "Σταφυλόκοκκος με αρνητική πηκτικότητα (CoNS)"</span>
|
||
<span class="r-in"><span></span></span>
|
||
<span class="r-in"><span><span class="co"># setting yet another language</span></span></span>
|
||
<span class="r-in"><span><span class="fu">set_AMR_locale</span><span class="op">(</span><span class="st">"Ukrainian"</span><span class="op">)</span></span></span>
|
||
<span class="r-msg co"><span class="r-pr">#></span> ℹ Using Ukrainian (Українська) for the AMR package for this session.</span>
|
||
<span class="r-in"><span><span class="fu"><a href="ab_property.html">ab_name</a></span><span class="op">(</span><span class="st">"Ciprofloxacin"</span><span class="op">)</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> [1] "Ципрофлоксацин"</span>
|
||
<span class="r-in"><span><span class="fu"><a href="mo_property.html">mo_name</a></span><span class="op">(</span><span class="st">"Coagulase-negative Staphylococcus (CoNS)"</span><span class="op">)</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> [1] "Коагулазонегативний стафілокок (КНС)"</span>
|
||
<span class="r-in"><span></span></span>
|
||
<span class="r-in"><span><span class="co"># set_AMR_locale() understands endonyms, English exonyms, and ISO-639-1:</span></span></span>
|
||
<span class="r-in"><span><span class="fu">set_AMR_locale</span><span class="op">(</span><span class="st">"Deutsch"</span><span class="op">)</span></span></span>
|
||
<span class="r-msg co"><span class="r-pr">#></span> ℹ Using German (Deutsch) for the AMR package for this session.</span>
|
||
<span class="r-in"><span><span class="fu">set_AMR_locale</span><span class="op">(</span><span class="st">"German"</span><span class="op">)</span></span></span>
|
||
<span class="r-msg co"><span class="r-pr">#></span> ℹ Using German (Deutsch) for the AMR package for this session.</span>
|
||
<span class="r-in"><span><span class="fu">set_AMR_locale</span><span class="op">(</span><span class="st">"de"</span><span class="op">)</span></span></span>
|
||
<span class="r-msg co"><span class="r-pr">#></span> ℹ Using German (Deutsch) for the AMR package for this session.</span>
|
||
<span class="r-in"><span></span></span>
|
||
<span class="r-in"><span><span class="co"># reset to system default</span></span></span>
|
||
<span class="r-in"><span><span class="fu">reset_AMR_locale</span><span class="op">(</span><span class="op">)</span></span></span>
|
||
<span class="r-msg co"><span class="r-pr">#></span> ℹ Using the English language (English) for the AMR package for this</span>
|
||
<span class="r-msg co"><span class="r-pr">#></span> session.</span>
|
||
</code></pre></div>
|
||
</div>
|
||
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
|
||
</nav></aside></div>
|
||
|
||
|
||
<footer><div class="pkgdown-footer-left">
|
||
<p></p><p><code>AMR</code> (for R). Developed at the <a target="_blank" href="https://www.rug.nl" class="external-link">University of Groningen</a> in collaboration with non-profit organisations<br><a target="_blank" href="https://www.certe.nl" class="external-link">Certe Medical Diagnostics and Advice Foundation</a> and <a target="_blank" href="https://www.umcg.nl" class="external-link">University Medical Center Groningen</a>.</p>
|
||
</div>
|
||
|
||
<div class="pkgdown-footer-right">
|
||
<p></p><p><a target="_blank" href="https://www.rug.nl" class="external-link"><img src="https://github.com/msberends/AMR/raw/main/pkgdown/logos/logo_rug.svg" style="max-width: 150px;"></a></p>
|
||
</div>
|
||
|
||
</footer></div>
|
||
|
||
|
||
|
||
|
||
|
||
</body></html>
|
||
|