AMR/docs/reference/translate.html

324 lines
14 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>
<!-- 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-04-13 21:09:56 +02:00
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/flatly/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" />
2019-05-10 16:44:59 +02:00
2019-10-13 09:31:58 +02:00
2020-04-13 21:09:56 +02: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>
2019-05-10 16:44:59 +02: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>
2019-10-13 09:31:58 +02:00
<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()." />
2020-07-08 14:48:06 +02:00
<meta property="og:image" content="https://msberends.github.io/AMR/logo.svg" />
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>
2020-08-21 11:40:13 +02:00
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">1.3.0.9006</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">
<span class="fa fa-home"></span>
Home
</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
<span class="fa fa-question-circle"></span>
How to
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="../articles/AMR.html">
<span class="fa fa-directions"></span>
Conduct AMR analysis
</a>
</li>
<li>
<a href="../articles/resistance_predict.html">
<span class="fa fa-dice"></span>
Predict antimicrobial resistance
</a>
</li>
2020-08-21 11:40:13 +02:00
<li>
<a href="../articles/datasets.html">
<span class="fa fa-database"></span>
Download our reference data sets for own use
</a>
</li>
2020-04-13 21:09:56 +02:00
<li>
<a href="../articles/PCA.html">
<span class="fa fa-compress"></span>
Conduct principal component analysis for AMR
</a>
</li>
2019-05-28 16:50:40 +02:00
<li>
<a href="../articles/MDR.html">
<span class="fa fa-skull-crossbones"></span>
Determine multi-drug resistance (MDR)
</a>
</li>
2019-05-10 16:44:59 +02:00
<li>
<a href="../articles/WHONET.html">
<span class="fa fa-globe-americas"></span>
Work with WHONET data
</a>
</li>
<li>
<a href="../articles/SPSS.html">
<span class="fa fa-file-upload"></span>
Import data from SPSS/SAS/Stata
</a>
</li>
<li>
<a href="../articles/EUCAST.html">
<span class="fa fa-exchange-alt"></span>
Apply EUCAST rules
</a>
</li>
<li>
<a href="../reference/mo_property.html">
<span class="fa fa-bug"></span>
Get properties of a microorganism
</a>
</li>
<li>
<a href="../reference/ab_property.html">
<span class="fa fa-capsules"></span>
Get properties of an antibiotic
</a>
</li>
<li>
<a href="../articles/benchmarks.html">
<span class="fa fa-shipping-fast"></span>
Other: benchmarks
</a>
</li>
</ul>
</li>
<li>
2020-07-28 18:39:57 +02:00
<a href="../reference/index.html">
2019-05-10 16:44:59 +02:00
<span class="fa fa-book-open"></span>
Manual
</a>
</li>
<li>
<a href="../authors.html">
<span class="fa fa-users"></span>
Authors
</a>
</li>
<li>
2020-07-28 18:39:57 +02:00
<a href="../news/index.html">
2019-05-10 16:44:59 +02:00
<span class="far fa far fa-newspaper"></span>
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">
<span class="fab fa 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">
<span class="fa 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>()</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-07-08 14:48:06 +02: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>.</p>
<p>Currently supported languages are (besides English): Dutch, French, German, Italian, Portuguese, 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>
2020-05-16 13:05:47 +02:00
<p>This file will be read by all functions where a translated output can be desired, like all <code><a href='mo_property.html'>mo_property()</a></code> functions (<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.).</p>
<p>The system language will be used at default, if that language is supported. The system language can be overwritten with <code><a href='https://rdrr.io/r/base/Sys.setenv.html'>Sys.setenv(AMR_locale = yourlanguage)</a></code>.</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>
<p>If the unlying code needs breaking changes, they will occur gradually. For example, a parameter 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>
2019-05-10 16:44:59 +02:00
<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-10-13 09:31:58 +02:00
2020-07-28 18:39:57 +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 analysis, the <a href='https://msberends.github.io/AMR/reference'>complete documentation of all functions</a> (which reads a lot easier than here in R) 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>
2019-10-13 09:31:58 +02:00
<pre class="examples"><span class='co'># The 'language' parameter 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>
2020-08-10 12:46:03 +02:00
<span class='fu'><a href='mo_property.html'>mo_name</a></span>(<span class='st'>"CoNS"</span>, language = <span class='st'>"en"</span>)
2019-05-10 16:44:59 +02:00
<span class='co'>#&gt; "Coagulase-negative Staphylococcus (CoNS)"</span>
<span class='co'># German</span>
2020-08-10 12:46:03 +02:00
<span class='fu'><a href='mo_property.html'>mo_name</a></span>(<span class='st'>"CoNS"</span>, language = <span class='st'>"de"</span>)
2019-05-10 16:44:59 +02:00
<span class='co'>#&gt; "Koagulase-negative Staphylococcus (KNS)"</span>
<span class='co'># Dutch</span>
2020-08-10 12:46:03 +02:00
<span class='fu'><a href='mo_property.html'>mo_name</a></span>(<span class='st'>"CoNS"</span>, language = <span class='st'>"nl"</span>)
2019-05-10 16:44:59 +02:00
<span class='co'>#&gt; "Coagulase-negatieve Staphylococcus (CNS)"</span>
<span class='co'># Spanish</span>
2020-08-10 12:46:03 +02:00
<span class='fu'><a href='mo_property.html'>mo_name</a></span>(<span class='st'>"CoNS"</span>, language = <span class='st'>"es"</span>)
2019-05-10 16:44:59 +02:00
<span class='co'>#&gt; "Staphylococcus coagulasa negativo (SCN)"</span>
<span class='co'># Italian</span>
2020-08-10 12:46:03 +02:00
<span class='fu'><a href='mo_property.html'>mo_name</a></span>(<span class='st'>"CoNS"</span>, language = <span class='st'>"it"</span>)
2019-05-10 16:44:59 +02:00
<span class='co'>#&gt; "Staphylococcus negativo coagulasi (CoNS)"</span>
<span class='co'># Portuguese</span>
2020-08-10 12:46:03 +02:00
<span class='fu'><a href='mo_property.html'>mo_name</a></span>(<span class='st'>"CoNS"</span>, language = <span class='st'>"pt"</span>)
2019-10-13 09:31:58 +02:00
<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">
2020-08-10 12:46:03 +02:00
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.5.1.9000.</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