mirror of
				https://github.com/msberends/AMR.git
				synced 2025-10-30 16:38:15 +01:00 
			
		
		
		
	(v1.2.0.9030) GitHub Actions
This commit is contained in:
		
							
								
								
									
										516
									
								
								docs_/reference/ggplot_rsi.html
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										516
									
								
								docs_/reference/ggplot_rsi.html
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,516 @@ | ||||
| <!-- 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>AMR plots with <code>ggplot2</code> — ggplot_rsi • 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" /> | ||||
|  | ||||
| <!-- jquery --> | ||||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script> | ||||
| <!-- Bootstrap --> | ||||
| <link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/flatly/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" /> | ||||
|  | ||||
|  | ||||
| <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> | ||||
|  | ||||
| <!-- bootstrap-toc --> | ||||
| <link rel="stylesheet" href="../bootstrap-toc.css"> | ||||
| <script src="../bootstrap-toc.js"></script> | ||||
|  | ||||
| <!-- 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" /> | ||||
|  | ||||
| <!-- 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> | ||||
|  | ||||
| <!-- 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> | ||||
|  | ||||
| <!-- 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="AMR plots with <code>ggplot2</code> — ggplot_rsi" /> | ||||
| <meta property="og:description" content="Use these functions to create bar plots for antimicrobial resistance analysis. All functions rely on ggplot2 functions." /> | ||||
| <meta property="og:image" content="https://msberends.github.io/AMR/logo.svg" /> | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| <!-- 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 data-spy="scroll" data-target="#toc"> | ||||
|     <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.2.0.9026</span> | ||||
|       </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> | ||||
|     <li> | ||||
|       <a href="../articles/PCA.html"> | ||||
|         <span class="fa fa-compress"></span> | ||||
|           | ||||
|         Conduct principal component analysis for AMR | ||||
|       </a> | ||||
|     </li> | ||||
|     <li> | ||||
|       <a href="../articles/MDR.html"> | ||||
|         <span class="fa fa-skull-crossbones"></span> | ||||
|           | ||||
|         Determine multi-drug resistance (MDR) | ||||
|       </a> | ||||
|     </li> | ||||
|     <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> | ||||
|   <a href="../reference/"> | ||||
|     <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> | ||||
|   <a href="../news/"> | ||||
|     <span class="far fa far fa-newspaper"></span> | ||||
|       | ||||
|     Changelog | ||||
|   </a> | ||||
| </li> | ||||
|       </ul> | ||||
|       <ul class="nav navbar-nav navbar-right"> | ||||
|         <li> | ||||
|   <a href="https://github.com/msberends/AMR"> | ||||
|     <span class="fab fa fab fa-github"></span> | ||||
|       | ||||
|     Source Code | ||||
|   </a> | ||||
| </li> | ||||
| <li> | ||||
|   <a href="../LICENSE-text.html"> | ||||
|     <span class="fa fa-book"></span> | ||||
|       | ||||
|     Licence | ||||
|   </a> | ||||
| </li> | ||||
|       </ul> | ||||
|        | ||||
|     </div><!--/.nav-collapse --> | ||||
|   </div><!--/.container --> | ||||
| </div><!--/.navbar --> | ||||
|  | ||||
|        | ||||
|  | ||||
|       </header> | ||||
|  | ||||
| <div class="row"> | ||||
|   <div class="col-md-9 contents"> | ||||
|     <div class="page-header"> | ||||
|     <h1>AMR plots with <code>ggplot2</code></h1> | ||||
|     <small class="dont-index">Source: <a href='https://github.com/msberends/AMR/blob/master/R/ggplot_rsi.R'><code>R/ggplot_rsi.R</code></a></small> | ||||
|     <div class="hidden name"><code>ggplot_rsi.Rd</code></div> | ||||
|     </div> | ||||
|  | ||||
|     <div class="ref-description"> | ||||
|     <p>Use these functions to create bar plots for antimicrobial resistance analysis. All functions rely on <a href='https://ggplot2.tidyverse.org/reference/ggplot.html'>ggplot2</a> functions.</p> | ||||
|     </div> | ||||
|  | ||||
|     <pre class="usage"><span class='fu'>ggplot_rsi</span>( | ||||
|   <span class='no'>data</span>, | ||||
|   <span class='kw'>position</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, | ||||
|   <span class='kw'>x</span> <span class='kw'>=</span> <span class='st'>"antibiotic"</span>, | ||||
|   <span class='kw'>fill</span> <span class='kw'>=</span> <span class='st'>"interpretation"</span>, | ||||
|   <span class='kw'>facet</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, | ||||
|   <span class='kw'>breaks</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/seq.html'>seq</a></span>(<span class='fl'>0</span>, <span class='fl'>1</span>, <span class='fl'>0.1</span>), | ||||
|   <span class='kw'>limits</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, | ||||
|   <span class='kw'>translate_ab</span> <span class='kw'>=</span> <span class='st'>"name"</span>, | ||||
|   <span class='kw'>combine_SI</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, | ||||
|   <span class='kw'>combine_IR</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, | ||||
|   <span class='kw'>language</span> <span class='kw'>=</span> <span class='fu'><a href='translate.html'>get_locale</a></span>(), | ||||
|   <span class='kw'>nrow</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, | ||||
|   <span class='kw'>colours</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='kw'>S</span> <span class='kw'>=</span> <span class='st'>"#61a8ff"</span>, <span class='kw'>SI</span> <span class='kw'>=</span> <span class='st'>"#61a8ff"</span>, <span class='kw'>I</span> <span class='kw'>=</span> <span class='st'>"#61f7ff"</span>, <span class='kw'>IR</span> <span class='kw'>=</span> <span class='st'>"#ff6961"</span>, <span class='kw'>R</span> <span class='kw'>=</span> | ||||
|     <span class='st'>"#ff6961"</span>), | ||||
|   <span class='kw'>datalabels</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, | ||||
|   <span class='kw'>datalabels.size</span> <span class='kw'>=</span> <span class='fl'>2.5</span>, | ||||
|   <span class='kw'>datalabels.colour</span> <span class='kw'>=</span> <span class='st'>"gray15"</span>, | ||||
|   <span class='kw'>title</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, | ||||
|   <span class='kw'>subtitle</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, | ||||
|   <span class='kw'>caption</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, | ||||
|   <span class='kw'>x.title</span> <span class='kw'>=</span> <span class='st'>"Antimicrobial"</span>, | ||||
|   <span class='kw'>y.title</span> <span class='kw'>=</span> <span class='st'>"Proportion"</span>, | ||||
|   <span class='no'>...</span> | ||||
| ) | ||||
|  | ||||
| <span class='fu'>geom_rsi</span>( | ||||
|   <span class='kw'>position</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, | ||||
|   <span class='kw'>x</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"antibiotic"</span>, <span class='st'>"interpretation"</span>), | ||||
|   <span class='kw'>fill</span> <span class='kw'>=</span> <span class='st'>"interpretation"</span>, | ||||
|   <span class='kw'>translate_ab</span> <span class='kw'>=</span> <span class='st'>"name"</span>, | ||||
|   <span class='kw'>language</span> <span class='kw'>=</span> <span class='fu'><a href='translate.html'>get_locale</a></span>(), | ||||
|   <span class='kw'>combine_SI</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, | ||||
|   <span class='kw'>combine_IR</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, | ||||
|   <span class='no'>...</span> | ||||
| ) | ||||
|  | ||||
| <span class='fu'>facet_rsi</span>(<span class='kw'>facet</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"interpretation"</span>, <span class='st'>"antibiotic"</span>), <span class='kw'>nrow</span> <span class='kw'>=</span> <span class='kw'>NULL</span>) | ||||
|  | ||||
| <span class='fu'>scale_y_percent</span>(<span class='kw'>breaks</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/seq.html'>seq</a></span>(<span class='fl'>0</span>, <span class='fl'>1</span>, <span class='fl'>0.1</span>), <span class='kw'>limits</span> <span class='kw'>=</span> <span class='kw'>NULL</span>) | ||||
|  | ||||
| <span class='fu'>scale_rsi_colours</span>( | ||||
|   <span class='kw'>colours</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='kw'>S</span> <span class='kw'>=</span> <span class='st'>"#61a8ff"</span>, <span class='kw'>SI</span> <span class='kw'>=</span> <span class='st'>"#61a8ff"</span>, <span class='kw'>I</span> <span class='kw'>=</span> <span class='st'>"#61f7ff"</span>, <span class='kw'>IR</span> <span class='kw'>=</span> <span class='st'>"#ff6961"</span>, <span class='kw'>R</span> <span class='kw'>=</span> | ||||
|     <span class='st'>"#ff6961"</span>) | ||||
| ) | ||||
|  | ||||
| <span class='fu'>theme_rsi</span>() | ||||
|  | ||||
| <span class='fu'>labels_rsi_count</span>( | ||||
|   <span class='kw'>position</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, | ||||
|   <span class='kw'>x</span> <span class='kw'>=</span> <span class='st'>"antibiotic"</span>, | ||||
|   <span class='kw'>translate_ab</span> <span class='kw'>=</span> <span class='st'>"name"</span>, | ||||
|   <span class='kw'>combine_SI</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, | ||||
|   <span class='kw'>combine_IR</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, | ||||
|   <span class='kw'>datalabels.size</span> <span class='kw'>=</span> <span class='fl'>3</span>, | ||||
|   <span class='kw'>datalabels.colour</span> <span class='kw'>=</span> <span class='st'>"gray15"</span> | ||||
| )</pre> | ||||
|  | ||||
|     <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2> | ||||
|     <table class="ref-arguments"> | ||||
|     <colgroup><col class="name" /><col class="desc" /></colgroup> | ||||
|     <tr> | ||||
|       <th>data</th> | ||||
|       <td><p>a <code><a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a></code> with column(s) of class <code><a href='as.rsi.html'>rsi</a></code> (see <code><a href='as.rsi.html'>as.rsi()</a></code>)</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>position</th> | ||||
|       <td><p>position adjustment of bars, either <code>"fill"</code>, <code>"stack"</code> or <code>"dodge"</code></p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>x</th> | ||||
|       <td><p>variable to show on x axis, either <code>"antibiotic"</code> (default) or <code>"interpretation"</code> or a grouping variable</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>fill</th> | ||||
|       <td><p>variable to categorise using the plots legend, either <code>"antibiotic"</code> (default) or <code>"interpretation"</code> or a grouping variable</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>facet</th> | ||||
|       <td><p>variable to split plots by, either <code>"interpretation"</code> (default) or <code>"antibiotic"</code> or a grouping variable</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>breaks</th> | ||||
|       <td><p>numeric vector of positions</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>limits</th> | ||||
|       <td><p>numeric vector of length two providing limits of the scale, use <code>NA</code> to refer to the existing minimum or maximum</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>translate_ab</th> | ||||
|       <td><p>a column name of the <a href='antibiotics.html'>antibiotics</a> data set to translate the antibiotic abbreviations to, using <code><a href='ab_property.html'>ab_property()</a></code>. Use a value</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>combine_SI</th> | ||||
|       <td><p>a logical to indicate whether all values of S and I must be merged into one, so the output only consists of S+I vs. R (susceptible vs. resistant). This used to be the parameter <code>combine_IR</code>, but this now follows the redefinition by EUCAST about the interpretion of I (increased exposure) in 2019, see section 'Interpretation of S, I and R' below. Default is <code>TRUE</code>.</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>combine_IR</th> | ||||
|       <td><p>a logical to indicate whether all values of I and R must be merged into one, so the output only consists of S vs. I+R (susceptible vs. non-susceptible). This is outdated, see parameter <code>combine_SI</code>.</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>language</th> | ||||
|       <td><p>language of the returned text, defaults to system language (see <code><a href='translate.html'>get_locale()</a></code>) and can also be set with <code><a href='https://rdrr.io/r/base/options.html'>getOption("AMR_locale")</a></code>. Use <code>language = NULL</code> or <code>language = ""</code> to prevent translation.</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>nrow</th> | ||||
|       <td><p>(when using <code>facet</code>) number of rows</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>colours</th> | ||||
|       <td><p>a named vector with colours for the bars. The names must be one or more of: S, SI, I, IR, R or be <code>FALSE</code> to use default [ggplot2][<code><a href='https://ggplot2.tidyverse.org/reference/ggplot.html'>ggplot2::ggplot()</a></code> colours.</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>datalabels</th> | ||||
|       <td><p>show datalabels using <code>labels_rsi_count()</code></p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>datalabels.size</th> | ||||
|       <td><p>size of the datalabels</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>datalabels.colour</th> | ||||
|       <td><p>colour of the datalabels</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>title</th> | ||||
|       <td><p>text to show as title of the plot</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>subtitle</th> | ||||
|       <td><p>text to show as subtitle of the plot</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>caption</th> | ||||
|       <td><p>text to show as caption of the plot</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>x.title</th> | ||||
|       <td><p>text to show as x axis description</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>y.title</th> | ||||
|       <td><p>text to show as y axis description</p></td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|       <th>...</th> | ||||
|       <td><p>other parameters passed on to <code>geom_rsi()</code></p></td> | ||||
|     </tr> | ||||
|     </table> | ||||
|  | ||||
|     <h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2> | ||||
|  | ||||
|     <p>At default, the names of antibiotics will be shown on the plots using <code><a href='ab_property.html'>ab_name()</a></code>. This can be set with the <code>translate_ab</code> parameter. See <code><a href='count.html'>count_df()</a></code>.</p><h3>The functions</h3> | ||||
|  | ||||
|  | ||||
| <p><code>geom_rsi()</code> will take any variable from the data that has an <code><a href='as.rsi.html'>rsi</a></code> class (created with <code><a href='as.rsi.html'>as.rsi()</a></code>) using <code><a href='proportion.html'>rsi_df()</a></code> and will plot bars with the percentage R, I and S. The default behaviour is to have the bars stacked and to have the different antibiotics on the x axis.</p> | ||||
| <p><code>facet_rsi()</code> creates 2d plots (at default based on S/I/R) using <code><a href='https://ggplot2.tidyverse.org/reference/facet_wrap.html'>ggplot2::facet_wrap()</a></code>.</p> | ||||
| <p><code>scale_y_percent()</code> transforms the y axis to a 0 to 100% range using <code><a href='https://ggplot2.tidyverse.org/reference/scale_continuous.html'>ggplot2::scale_y_continuous()</a></code>.</p> | ||||
| <p><code>scale_rsi_colours()</code> sets colours to the bars: pastel blue for S, pastel turquoise for I and pastel red for R, using <code><a href='https://ggplot2.tidyverse.org/reference/scale_manual.html'>ggplot2::scale_fill_manual()</a></code>.</p> | ||||
| <p><code>theme_rsi()</code> is a [ggplot2 theme][<code><a href='https://ggplot2.tidyverse.org/reference/theme.html'>ggplot2::theme()</a></code> with minimal distraction.</p> | ||||
| <p><code>labels_rsi_count()</code> print datalabels on the bars with percentage and amount of isolates using <code><a href='https://ggplot2.tidyverse.org/reference/geom_text.html'>ggplot2::geom_text()</a></code>.</p> | ||||
| <p><code>ggplot_rsi()</code> is a wrapper around all above functions that uses data as first input. This makes it possible to use this function after a pipe (<code>%>%</code>). See Examples.</p> | ||||
|  | ||||
|     <h2 class="hasAnchor" id="maturing-lifecycle"><a class="anchor" href="#maturing-lifecycle"></a>Maturing lifecycle</h2> | ||||
|  | ||||
|      | ||||
|  | ||||
| <p><img src='figures/lifecycle_maturing.svg' style=margin-bottom:5px /> <br /> | ||||
| The <a href='lifecycle.html'>lifecycle</a> of this function is <strong>maturing</strong>. The unlying code of a maturing function has been roughed out, but finer details might still change. Since this function needs wider usage and more extensive testing, you are very welcome <a href='https://github.com/msberends/AMR/issues'>to suggest changes at our repository</a> or <a href='AMR.html'>write us an email (see section 'Contact Us')</a>.</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> | ||||
|  | ||||
|      | ||||
|  | ||||
| <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>.</p> | ||||
|  | ||||
|     <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> | ||||
|     <pre class="examples"><span class='kw'>if</span> (<span class='fu'><a href='https://rdrr.io/r/base/library.html'>require</a></span>(<span class='st'>"ggplot2"</span>) <span class='kw'>&</span> <span class='fu'><a href='https://rdrr.io/r/base/library.html'>require</a></span>(<span class='st'>"dplyr"</span>)) { | ||||
|  | ||||
|   <span class='co'># get antimicrobial results for drugs against a UTI:</span> | ||||
|   <span class='fu'><a href='https://ggplot2.tidyverse.org/reference/ggplot.html'>ggplot</a></span>(<span class='no'>example_isolates</span> <span class='kw'>%>%</span> <span class='fu'><a href='https://dplyr.tidyverse.org/reference/select.html'>select</a></span>(<span class='no'>AMX</span>, <span class='no'>NIT</span>, <span class='no'>FOS</span>, <span class='no'>TMP</span>, <span class='no'>CIP</span>)) + | ||||
|     <span class='fu'>geom_rsi</span>() | ||||
|  | ||||
|   <span class='co'># prettify the plot using some additional functions:</span> | ||||
|   <span class='no'>df</span> <span class='kw'><-</span> <span class='no'>example_isolates</span> <span class='kw'>%>%</span> <span class='fu'><a href='https://dplyr.tidyverse.org/reference/select.html'>select</a></span>(<span class='no'>AMX</span>, <span class='no'>NIT</span>, <span class='no'>FOS</span>, <span class='no'>TMP</span>, <span class='no'>CIP</span>) | ||||
|   <span class='fu'><a href='https://ggplot2.tidyverse.org/reference/ggplot.html'>ggplot</a></span>(<span class='no'>df</span>) + | ||||
|     <span class='fu'>geom_rsi</span>() + | ||||
|     <span class='fu'>scale_y_percent</span>() + | ||||
|     <span class='fu'>scale_rsi_colours</span>() + | ||||
|     <span class='fu'>labels_rsi_count</span>() + | ||||
|     <span class='fu'>theme_rsi</span>() | ||||
|  | ||||
|   <span class='co'># or better yet, simplify this using the wrapper function - a single command:</span> | ||||
|   <span class='no'>example_isolates</span> <span class='kw'>%>%</span> | ||||
|     <span class='fu'><a href='https://dplyr.tidyverse.org/reference/select.html'>select</a></span>(<span class='no'>AMX</span>, <span class='no'>NIT</span>, <span class='no'>FOS</span>, <span class='no'>TMP</span>, <span class='no'>CIP</span>) <span class='kw'>%>%</span> | ||||
|     <span class='fu'>ggplot_rsi</span>() | ||||
|  | ||||
|   <span class='co'># get only proportions and no counts:</span> | ||||
|   <span class='no'>example_isolates</span> <span class='kw'>%>%</span> | ||||
|     <span class='fu'><a href='https://dplyr.tidyverse.org/reference/select.html'>select</a></span>(<span class='no'>AMX</span>, <span class='no'>NIT</span>, <span class='no'>FOS</span>, <span class='no'>TMP</span>, <span class='no'>CIP</span>) <span class='kw'>%>%</span> | ||||
|     <span class='fu'>ggplot_rsi</span>(<span class='kw'>datalabels</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>) | ||||
|  | ||||
|   <span class='co'># add other ggplot2 parameters as you like:</span> | ||||
|   <span class='no'>example_isolates</span> <span class='kw'>%>%</span> | ||||
|     <span class='fu'><a href='https://dplyr.tidyverse.org/reference/select.html'>select</a></span>(<span class='no'>AMX</span>, <span class='no'>NIT</span>, <span class='no'>FOS</span>, <span class='no'>TMP</span>, <span class='no'>CIP</span>) <span class='kw'>%>%</span> | ||||
|     <span class='fu'>ggplot_rsi</span>(<span class='kw'>width</span> <span class='kw'>=</span> <span class='fl'>0.5</span>, | ||||
|                <span class='kw'>colour</span> <span class='kw'>=</span> <span class='st'>"black"</span>, | ||||
|                <span class='kw'>size</span> <span class='kw'>=</span> <span class='fl'>1</span>, | ||||
|                <span class='kw'>linetype</span> <span class='kw'>=</span> <span class='fl'>2</span>, | ||||
|                <span class='kw'>alpha</span> <span class='kw'>=</span> <span class='fl'>0.25</span>) | ||||
|  | ||||
|   <span class='no'>example_isolates</span> <span class='kw'>%>%</span> | ||||
|     <span class='fu'><a href='https://dplyr.tidyverse.org/reference/select.html'>select</a></span>(<span class='no'>AMX</span>) <span class='kw'>%>%</span> | ||||
|     <span class='fu'>ggplot_rsi</span>(<span class='kw'>colours</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='kw'>SI</span> <span class='kw'>=</span> <span class='st'>"yellow"</span>)) | ||||
|  | ||||
| } | ||||
|  | ||||
| <span class='kw'>if</span> (<span class='fl'>FALSE</span>) { | ||||
|  | ||||
| <span class='co'># resistance of ciprofloxacine per age group</span> | ||||
| <span class='no'>example_isolates</span> <span class='kw'>%>%</span> | ||||
|   <span class='fu'><a href='https://dplyr.tidyverse.org/reference/mutate.html'>mutate</a></span>(<span class='kw'>first_isolate</span> <span class='kw'>=</span> <span class='fu'><a href='first_isolate.html'>first_isolate</a></span>(<span class='no'>.</span>)) <span class='kw'>%>%</span> | ||||
|   <span class='fu'><a href='https://dplyr.tidyverse.org/reference/filter.html'>filter</a></span>(<span class='no'>first_isolate</span> <span class='kw'>==</span> <span class='fl'>TRUE</span>, | ||||
|          <span class='no'>mo</span> <span class='kw'>==</span> <span class='fu'><a href='as.mo.html'>as.mo</a></span>(<span class='st'>"E. coli"</span>)) <span class='kw'>%>%</span> | ||||
|   <span class='co'># `age_group` is also a function of this package:</span> | ||||
|   <span class='fu'><a href='https://dplyr.tidyverse.org/reference/group_by.html'>group_by</a></span>(<span class='kw'>age_group</span> <span class='kw'>=</span> <span class='fu'><a href='age_groups.html'>age_groups</a></span>(<span class='no'>age</span>)) <span class='kw'>%>%</span> | ||||
|   <span class='fu'><a href='https://dplyr.tidyverse.org/reference/select.html'>select</a></span>(<span class='no'>age_group</span>, | ||||
|          <span class='no'>CIP</span>) <span class='kw'>%>%</span> | ||||
|   <span class='fu'>ggplot_rsi</span>(<span class='kw'>x</span> <span class='kw'>=</span> <span class='st'>"age_group"</span>) | ||||
|  | ||||
| <span class='co'># for colourblind mode, use divergent colours from the viridis package:</span> | ||||
| <span class='no'>example_isolates</span> <span class='kw'>%>%</span> | ||||
|   <span class='fu'><a href='https://dplyr.tidyverse.org/reference/select.html'>select</a></span>(<span class='no'>AMX</span>, <span class='no'>NIT</span>, <span class='no'>FOS</span>, <span class='no'>TMP</span>, <span class='no'>CIP</span>) <span class='kw'>%>%</span> | ||||
|   <span class='fu'>ggplot_rsi</span>() + <span class='fu'><a href='https://ggplot2.tidyverse.org/reference/scale_viridis.html'>scale_fill_viridis_d</a></span>() | ||||
| <span class='co'># a shorter version which also adjusts data label colours:</span> | ||||
| <span class='no'>example_isolates</span> <span class='kw'>%>%</span> | ||||
|   <span class='fu'><a href='https://dplyr.tidyverse.org/reference/select.html'>select</a></span>(<span class='no'>AMX</span>, <span class='no'>NIT</span>, <span class='no'>FOS</span>, <span class='no'>TMP</span>, <span class='no'>CIP</span>) <span class='kw'>%>%</span> | ||||
|   <span class='fu'>ggplot_rsi</span>(<span class='kw'>colours</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>) | ||||
|  | ||||
|  | ||||
| <span class='co'># it also supports groups (don't forget to use the group var on `x` or `facet`):</span> | ||||
| <span class='no'>example_isolates</span> <span class='kw'>%>%</span> | ||||
|   <span class='fu'><a href='https://dplyr.tidyverse.org/reference/select.html'>select</a></span>(<span class='no'>hospital_id</span>, <span class='no'>AMX</span>, <span class='no'>NIT</span>, <span class='no'>FOS</span>, <span class='no'>TMP</span>, <span class='no'>CIP</span>) <span class='kw'>%>%</span> | ||||
|   <span class='fu'><a href='https://dplyr.tidyverse.org/reference/group_by.html'>group_by</a></span>(<span class='no'>hospital_id</span>) <span class='kw'>%>%</span> | ||||
|   <span class='fu'>ggplot_rsi</span>(<span class='kw'>x</span> <span class='kw'>=</span> <span class='st'>"hospital_id"</span>, | ||||
|              <span class='kw'>facet</span> <span class='kw'>=</span> <span class='st'>"antibiotic"</span>, | ||||
|              <span class='kw'>nrow</span> <span class='kw'>=</span> <span class='fl'>1</span>, | ||||
|              <span class='kw'>title</span> <span class='kw'>=</span> <span class='st'>"AMR of Anti-UTI Drugs Per Hospital"</span>, | ||||
|              <span class='kw'>x.title</span> <span class='kw'>=</span> <span class='st'>"Hospital"</span>, | ||||
|              <span class='kw'>datalabels</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>) | ||||
| }</pre> | ||||
|   </div> | ||||
|   <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar"> | ||||
|     <nav id="toc" data-toggle="toc" class="sticky-top"> | ||||
|       <h2 data-toc-skip>Contents</h2> | ||||
|     </nav> | ||||
|   </div> | ||||
| </div> | ||||
|  | ||||
|  | ||||
|       <footer> | ||||
|       <div class="copyright"> | ||||
|   <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> | ||||
| </div> | ||||
|  | ||||
| <div class="pkgdown"> | ||||
|   <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.5.1.</p> | ||||
| </div> | ||||
|  | ||||
|       </footer> | ||||
|    </div> | ||||
|  | ||||
|    | ||||
|  | ||||
|  | ||||
|   </body> | ||||
| </html> | ||||
|  | ||||
|  | ||||
		Reference in New Issue
	
	Block a user