stRoke/reference/chunks_of_n.html

169 lines
16 KiB
HTML
Raw Normal View History

<!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>Split to chunks of size n — chunks_of_n • 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="Split to chunks of size n — chunks_of_n"><meta name="description" content="Split to chunks of size n"><meta property="og:description" content="Split to chunks of size n"><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>Split to chunks of size n</h1>
<small class="dont-index">Source: <a href="https://github.com/agdamsbo/stRoke/blob/main/R/chunks_of_n.R" class="external-link"><code>R/chunks_of_n.R</code></a></small>
<div class="d-none name"><code>chunks_of_n.Rd</code></div>
</div>
<div class="ref-description section level2">
<p>Split to chunks of size n</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">chunks_of_n</span><span class="op">(</span><span class="va">d</span>, <span class="va">n</span>, label <span class="op">=</span> <span class="cn">NULL</span>, even <span class="op">=</span> <span class="cn">FALSE</span>, pattern <span class="op">=</span> <span class="cn">NULL</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-d">d<a class="anchor" aria-label="anchor" href="#arg-d"></a></dt>
<dd><p>data. Can be vector or data frame.</p></dd>
<dt id="arg-n">n<a class="anchor" aria-label="anchor" href="#arg-n"></a></dt>
<dd><p>number of chunks</p></dd>
<dt id="arg-label">label<a class="anchor" aria-label="anchor" href="#arg-label"></a></dt>
<dd><p>naming prefix for chunk names</p></dd>
<dt id="arg-even">even<a class="anchor" aria-label="anchor" href="#arg-even"></a></dt>
<dd><p>boolean to set if size of chunks should be evenly distributed.</p></dd>
<dt id="arg-pattern">pattern<a class="anchor" aria-label="anchor" href="#arg-pattern"></a></dt>
<dd><p>regex pattern to extract names from provided vector. If data
frame, will assume first column is name.</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>List of length n</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="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">tail</a></span><span class="op">(</span><span class="fu">chunks_of_n</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/seq.html" class="external-link">seq_len</a></span><span class="op">(</span><span class="fl">100</span><span class="op">)</span>,<span class="fl">7</span><span class="op">)</span>,<span class="fl">3</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`13`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 85 86 87 88 89 90 91</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`14`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 92 93 94 95 96 97 98</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`15`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 99 100</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">tail</a></span><span class="op">(</span><span class="fu">chunks_of_n</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/seq.html" class="external-link">seq_len</a></span><span class="op">(</span><span class="fl">100</span><span class="op">)</span>,<span class="fl">7</span>,even<span class="op">=</span><span class="cn">TRUE</span><span class="op">)</span>,<span class="fl">3</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`13`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 83 84 85 86 87 88</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`14`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 89 90 91 92 93 94</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`15`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 95 96 97 98 99 100</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-in"><span><span class="va">ds</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span>nm<span class="op">=</span><span class="fu"><a href="https://rdrr.io/r/base/paste.html" class="external-link">paste0</a></span><span class="op">(</span><span class="st">"Sub"</span>,</span></span>
<span class="r-in"><span><span class="fu"><a href="add_padding.html">add_padding</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/colnames.html" class="external-link">rownames</a></span><span class="op">(</span><span class="fu">stRoke</span><span class="fu">::</span><span class="va"><a href="talos.html">talos</a></span><span class="op">)</span><span class="op">)</span><span class="op">)</span>,<span class="fu">stRoke</span><span class="fu">::</span><span class="va"><a href="talos.html">talos</a></span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">head</a></span><span class="op">(</span><span class="fu">chunks_of_n</span><span class="op">(</span><span class="va">ds</span>,<span class="fl">7</span>,pattern<span class="op">=</span><span class="st">"Sub[0-9]{3}"</span>,label<span class="op">=</span><span class="st">"grp"</span><span class="op">)</span>,<span class="fl">2</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`grp-Sub038-Sub011`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> nm rtreat mrs_1 mrs_6 hypertension diabetes civil</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 38 Sub038 Active 1 1 no no partner</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 434 Sub434 Active 1 1 yes no partner</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 588 Sub588 Active 2 2 yes no partner</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 42 Sub042 Active 0 0 yes no partner</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 160 Sub160 Placebo 1 1 yes no partner</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 174 Sub174 Active 0 1 yes no alone</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 11 Sub011 Placebo 2 1 yes yes alone</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`grp-Sub601-Sub062`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> nm rtreat mrs_1 mrs_6 hypertension diabetes civil</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 601 Sub601 Placebo 1 1 no no partner</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 412 Sub412 Active 0 0 yes no partner</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 88 Sub088 Placebo 1 1 yes yes partner</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 56 Sub056 Placebo 0 0 no no alone</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 235 Sub235 Placebo 2 1 yes yes alone</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 205 Sub205 Active 3 3 no no partner</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 62 Sub062 Active 2 2 yes no alone</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-in"><span><span class="co">## Please notice that no sorting is performed. This is on purpose to preserve</span></span></span>
<span class="r-in"><span><span class="co">## original sorting. If sorting is intended, try something like this:</span></span></span>
<span class="r-in"><span><span class="va">ds</span><span class="op">[</span><span class="fu"><a href="https://rdrr.io/r/base/order.html" class="external-link">order</a></span><span class="op">(</span><span class="va">ds</span><span class="op">$</span><span class="va">nm</span><span class="op">)</span>,<span class="op">]</span> <span class="op">|&gt;</span> <span class="fu">chunks_of_n</span><span class="op">(</span><span class="fl">7</span>,pattern<span class="op">=</span><span class="st">"Sub[0-9]{3}"</span>,label<span class="op">=</span><span class="st">"grp"</span><span class="op">)</span> <span class="op">|&gt;</span> </span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">head</a></span><span class="op">(</span><span class="fl">2</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`grp-Sub001-Sub020`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> nm rtreat mrs_1 mrs_6 hypertension diabetes civil</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 1 Sub001 Placebo 0 0 yes no partner</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 2 Sub002 Placebo 2 1 no no partner</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 7 Sub007 Placebo 1 1 yes no partner</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 9 Sub009 Placebo 1 1 no no partner</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 11 Sub011 Placebo 2 1 yes yes alone</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 13 Sub013 Active 1 1 yes no partner</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 20 Sub020 Placebo 1 2 no no alone</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`grp-Sub022-Sub038`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> nm rtreat mrs_1 mrs_6 hypertension diabetes civil</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 22 Sub022 Placebo 2 1 no no partner</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 26 Sub026 Placebo 2 4 no no alone</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 28 Sub028 Active 2 2 yes no partner</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 29 Sub029 Placebo 2 2 no no alone</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 33 Sub033 Placebo 0 0 yes no alone</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 34 Sub034 Active 1 1 no no alone</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 38 Sub038 Active 1 1 no no partner</span>
<span class="r-out co"><span class="r-pr">#&gt;</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>