mirror of
https://github.com/agdamsbo/stRoke.git
synced 2024-11-25 14:11:54 +01:00
140 lines
9.8 KiB
HTML
140 lines
9.8 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"><title>Confidence interval plot with point estimate — ci_plot • stRoke</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.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Confidence interval plot with point estimate — ci_plot"><meta name="description" content='Horizontal forest plot of point estimate with confidence intervals.
|
|
Includes dichotomous or olr, depending on number of levels in "x".
|
|
Title and axis labels can be added to the ggplot afterwards.'><meta property="og:description" content='Horizontal forest plot of point estimate with confidence intervals.
|
|
Includes dichotomous or olr, depending on number of levels in "x".
|
|
Title and axis labels can be added to the ggplot afterwards.'><meta property="og:image" content="https://agdamsbo.github.io/stRoke/logo.png"></head><body>
|
|
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
|
|
|
|
|
<nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">
|
|
|
|
<a class="navbar-brand me-2" href="../index.html">stRoke</a>
|
|
|
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">24.10.1</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="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
|
|
<li class="nav-item dropdown">
|
|
<button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
|
|
<ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="../articles/toolbox.html">Toolbox</a></li>
|
|
</ul></li>
|
|
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
|
|
</ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
|
|
<input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
|
|
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/agdamsbo/stRoke/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></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.png" class="logo" alt=""><h1>Confidence interval plot with point estimate</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/agdamsbo/stRoke/blob/main/R/ci_plot.R" class="external-link"><code>R/ci_plot.R</code></a></small>
|
|
<div class="d-none name"><code>ci_plot.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description section level2">
|
|
<p>Horizontal forest plot of point estimate with confidence intervals.
|
|
Includes dichotomous or olr, depending on number of levels in "x".
|
|
Title and axis labels can be added to the ggplot afterwards.</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">ci_plot</span><span class="op">(</span></span>
|
|
<span> <span class="va">ds</span>,</span>
|
|
<span> x <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> y <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> vars <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> dec <span class="op">=</span> <span class="fl">3</span>,</span>
|
|
<span> lbls <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> title <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> method <span class="op">=</span> <span class="st">"auto"</span></span>
|
|
<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 id="arg-ds">ds<a class="anchor" aria-label="anchor" href="#arg-ds"></a></dt>
|
|
<dd><p>main input, either data set or logistic model</p></dd>
|
|
|
|
|
|
<dt id="arg-x">x<a class="anchor" aria-label="anchor" href="#arg-x"></a></dt>
|
|
<dd><p>text string of main exposure variable</p></dd>
|
|
|
|
|
|
<dt id="arg-y">y<a class="anchor" aria-label="anchor" href="#arg-y"></a></dt>
|
|
<dd><p>text string of outcome variable</p></dd>
|
|
|
|
|
|
<dt id="arg-vars">vars<a class="anchor" aria-label="anchor" href="#arg-vars"></a></dt>
|
|
<dd><p>variables for multivariate analysis.</p></dd>
|
|
|
|
|
|
<dt id="arg-dec">dec<a class="anchor" aria-label="anchor" href="#arg-dec"></a></dt>
|
|
<dd><p>Decimals in labels</p></dd>
|
|
|
|
|
|
<dt id="arg-lbls">lbls<a class="anchor" aria-label="anchor" href="#arg-lbls"></a></dt>
|
|
<dd><p>Labels for variable names</p></dd>
|
|
|
|
|
|
<dt id="arg-title">title<a class="anchor" aria-label="anchor" href="#arg-title"></a></dt>
|
|
<dd><p>Plot title. Can be specified later.</p></dd>
|
|
|
|
|
|
<dt id="arg-method">method<a class="anchor" aria-label="anchor" href="#arg-method"></a></dt>
|
|
<dd><p>Character vector. The method for the regression.
|
|
Can be c("auto", "model").</p></dd>
|
|
|
|
</dl></div>
|
|
<div class="section level2">
|
|
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
|
<p>ggplot element</p>
|
|
</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"># Auto plot</span></span></span>
|
|
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/data.html" class="external-link">data</a></span><span class="op">(</span><span class="va">talos</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span><span class="va">talos</span><span class="op">[</span>,<span class="st">"mrs_1"</span><span class="op">]</span><span class="op"><-</span><span class="fu"><a href="https://rdrr.io/r/base/factor.html" class="external-link">factor</a></span><span class="op">(</span><span class="va">talos</span><span class="op">[</span>,<span class="st">"mrs_1"</span><span class="op">]</span>,ordered<span class="op">=</span><span class="cn">TRUE</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span><span class="fu">ci_plot</span><span class="op">(</span>ds <span class="op">=</span> <span class="va">talos</span>, x <span class="op">=</span> <span class="st">"rtreat"</span>, y <span class="op">=</span> <span class="st">"mrs_1"</span>, </span></span>
|
|
<span class="r-in"><span>vars <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"hypertension"</span>,<span class="st">"diabetes"</span><span class="op">)</span><span class="op">)</span></span></span>
|
|
<span class="r-msg co"><span class="r-pr">#></span> Waiting for profiling to be done...</span>
|
|
<span class="r-plt img"><img src="ci_plot-1.png" alt="" width="700" height="433"></span>
|
|
<span class="r-in"><span><span class="co">## Model plot</span></span></span>
|
|
<span class="r-in"><span><span class="co"># iris$ord<-factor(sample(1:3,size=nrow(iris),replace=TRUE),ordered=TRUE)</span></span></span>
|
|
<span class="r-in"><span><span class="co"># lm <- MASS::polr(ord~., data=iris, Hess=TRUE, method="logistic")</span></span></span>
|
|
<span class="r-in"><span><span class="co"># ci_plot(ds = lm, method="model")</span></span></span>
|
|
</code></pre></div>
|
|
</div>
|
|
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
|
|
</nav></aside></div>
|
|
|
|
|
|
<footer><div class="pkgdown-footer-left">
|
|
<p>Developed by Andreas Gammelgaard Damsbo.</p>
|
|
</div>
|
|
|
|
<div class="pkgdown-footer-right">
|
|
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.1.</p>
|
|
</div>
|
|
|
|
</footer></div>
|
|
|
|
|
|
|
|
|
|
|
|
</body></html>
|
|
|