REDCapCAST/reference/fct_drop.html

149 lines
15 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Drop unused levels preserving label data — fct_drop • REDCapCAST</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.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.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="Drop unused levels preserving label data — fct_drop"><meta name="description" content="This extends [forcats::fct_drop()] to natively work across a data.frame and
replaces [base::droplevels()]."><meta property="og:description" content="This extends [forcats::fct_drop()] to natively work across a data.frame and
replaces [base::droplevels()]."><meta property="og:image" content="https://agdamsbo.github.io/REDCapCAST/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">REDCapCAST</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">24.12.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="nav-item"><a class="nav-link" href="../articles/REDCapCAST.html">Get started</a></li>
<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/Database-creation.html">Database-creation</a></li>
<li><a class="dropdown-item" href="../articles/Shiny-app.html">Shiny-app</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/REDCapCAST/" 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>Drop unused levels preserving label data</h1>
<small class="dont-index">Source: <a href="https://github.com/agdamsbo/REDCapCAST/blob/main/R/fct_drop.R" class="external-link"><code>R/fct_drop.R</code></a></small>
<div class="d-none name"><code>fct_drop.Rd</code></div>
</div>
<div class="ref-description section level2">
<p>This extends [forcats::fct_drop()] to natively work across a data.frame and
replaces [base::droplevels()].</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">fct_drop</span><span class="op">(</span><span class="va">x</span>, <span class="va">...</span><span class="op">)</span></span>
<span></span>
<span><span class="co"># S3 method for class 'data.frame'</span></span>
<span><span class="fu">fct_drop</span><span class="op">(</span><span class="va">x</span>, <span class="va">...</span><span class="op">)</span></span>
<span></span>
<span><span class="co"># S3 method for class 'factor'</span></span>
<span><span class="fu">fct_drop</span><span class="op">(</span><span class="va">x</span>, <span class="va">...</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-x">x<a class="anchor" aria-label="anchor" href="#arg-x"></a></dt>
<dd><p>Factor to drop unused levels</p></dd>
<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
<dd><p>Other arguments passed down to method.</p></dd>
</dl></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="va">mtcars</span> <span class="op">|&gt;</span></span></span>
<span class="r-in"><span> <span class="fu"><a href="numchar2fct.html">numchar2fct</a></span><span class="op">(</span><span class="op">)</span> <span class="op">|&gt;</span></span></span>
<span class="r-in"><span> <span class="fu">fct_drop</span><span class="op">(</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494;"># A tibble: 32 × 11</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> mpg cyl disp hp drat wt qsec vs am gear carb </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;fct&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;fct&gt;</span> <span style="color: #949494; font-style: italic;">&lt;fct&gt;</span> <span style="color: #949494; font-style: italic;">&lt;fct&gt;</span> <span style="color: #949494; font-style: italic;">&lt;fct&gt;</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 1</span> 21 6 160 110 3.9 2.62 16.5 0 1 4 4 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 2</span> 21 6 160 110 3.9 2.88 17.0 0 1 4 4 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 3</span> 22.8 4 108 93 3.85 2.32 18.6 1 1 4 1 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 4</span> 21.4 6 258 110 3.08 3.22 19.4 1 0 3 1 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 5</span> 18.7 8 360 175 3.15 3.44 17.0 0 0 3 2 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 6</span> 18.1 6 225 105 2.76 3.46 20.2 1 0 3 1 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 7</span> 14.3 8 360 245 3.21 3.57 15.8 0 0 3 4 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 8</span> 24.4 4 147. 62 3.69 3.19 20 1 0 4 2 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 9</span> 22.8 4 141. 95 3.92 3.15 22.9 1 0 4 2 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">10</span> 19.2 6 168. 123 3.92 3.44 18.3 1 0 4 4 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494;"># 22 more rows</span></span>
<span class="r-in"><span><span class="va">mtcars</span> <span class="op">|&gt;</span></span></span>
<span class="r-in"><span> <span class="fu"><a href="numchar2fct.html">numchar2fct</a></span><span class="op">(</span><span class="op">)</span> <span class="op">|&gt;</span></span></span>
<span class="r-in"><span> <span class="fu">dplyr</span><span class="fu">::</span><span class="fu"><a href="https://dplyr.tidyverse.org/reference/mutate.html" class="external-link">mutate</a></span><span class="op">(</span>vs <span class="op">=</span> <span class="fu">fct_drop</span><span class="op">(</span><span class="va">vs</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> mpg cyl disp hp drat wt qsec vs am gear carb</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Mazda RX4 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Mazda RX4 Wag 21.0 6 160.0 110 3.90 2.875 17.02 0 1 4 4</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Datsun 710 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Hornet 4 Drive 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Hornet Sportabout 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Valiant 18.1 6 225.0 105 2.76 3.460 20.22 1 0 3 1</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Duster 360 14.3 8 360.0 245 3.21 3.570 15.84 0 0 3 4</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Merc 240D 24.4 4 146.7 62 3.69 3.190 20.00 1 0 4 2</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Merc 230 22.8 4 140.8 95 3.92 3.150 22.90 1 0 4 2</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Merc 280 19.2 6 167.6 123 3.92 3.440 18.30 1 0 4 4</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Merc 280C 17.8 6 167.6 123 3.92 3.440 18.90 1 0 4 4</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Merc 450SE 16.4 8 275.8 180 3.07 4.070 17.40 0 0 3 3</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Merc 450SL 17.3 8 275.8 180 3.07 3.730 17.60 0 0 3 3</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Merc 450SLC 15.2 8 275.8 180 3.07 3.780 18.00 0 0 3 3</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Cadillac Fleetwood 10.4 8 472.0 205 2.93 5.250 17.98 0 0 3 4</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Lincoln Continental 10.4 8 460.0 215 3.00 5.424 17.82 0 0 3 4</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Chrysler Imperial 14.7 8 440.0 230 3.23 5.345 17.42 0 0 3 4</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Fiat 128 32.4 4 78.7 66 4.08 2.200 19.47 1 1 4 1</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Honda Civic 30.4 4 75.7 52 4.93 1.615 18.52 1 1 4 2</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Toyota Corolla 33.9 4 71.1 65 4.22 1.835 19.90 1 1 4 1</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Toyota Corona 21.5 4 120.1 97 3.70 2.465 20.01 1 0 3 1</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Dodge Challenger 15.5 8 318.0 150 2.76 3.520 16.87 0 0 3 2</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> AMC Javelin 15.2 8 304.0 150 3.15 3.435 17.30 0 0 3 2</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Camaro Z28 13.3 8 350.0 245 3.73 3.840 15.41 0 0 3 4</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Pontiac Firebird 19.2 8 400.0 175 3.08 3.845 17.05 0 0 3 2</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Fiat X1-9 27.3 4 79.0 66 4.08 1.935 18.90 1 1 4 1</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Porsche 914-2 26.0 4 120.3 91 4.43 2.140 16.70 0 1 5 2</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Lotus Europa 30.4 4 95.1 113 3.77 1.513 16.90 1 1 5 2</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Ford Pantera L 15.8 8 351.0 264 4.22 3.170 14.50 0 1 5 4</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Ferrari Dino 19.7 6 145.0 175 3.62 2.770 15.50 0 1 5 6</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Maserati Bora 15.0 8 301.0 335 3.54 3.570 14.60 0 1 5 8</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Volvo 142E 21.4 4 121.0 109 4.11 2.780 18.60 1 1 4 2</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, Paul Egeler.</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>