/
as.flist.html
228 lines (196 loc) · 16.7 KB
/
as.flist.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
<!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.0"><title>Convert to a formatting list — as.flist • fmtr</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 rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" 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><script src="../extra.js"></script><meta property="og:title" content="Convert to a formatting list — as.flist"><meta property="og:description" content="Converts an object to a formatting list. All
other parameters are the same as the flist function."><meta property="og:image" content="https://fmtr.r-sassy.org/logo.png"><!-- 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-inverse 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">fmtr</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">1.6.2</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav"></ul><ul class="nav navbar-nav navbar-right"><li>
<a href="../articles/fmtr.html">Get started</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
Articles
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu"><li>
<a href="../articles/fmtr-fdata.html">Format Data Function</a>
</li>
<li>
<a href="../articles/fmtr-fapply.html">Format Apply Function</a>
</li>
<li>
<a href="../articles/fmtr-fcat.html">Format Catalogs</a>
</li>
<li>
<a href="../articles/fmtr-convenience.html">Convenience Functions</a>
</li>
<li>
<a href="../articles/fmtr-helpers.html">Helper Functions</a>
</li>
<li>
<a href="../articles/fmtr-example1.html">Complete Example</a>
</li>
<li>
<a href="../articles/fmtr-faq.html">Frequently Asked Questions</a>
</li>
</ul></li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
<li>
<a href=".././articles/fmtr-faq.html">FAQ</a>
</li>
<li>
<a href="../news/index.html">Changelog</a>
</li>
<li>
<a href="https://github.com/dbosak01/fmtr/" class="external-link">
<span class="fab fa-github fa-lg"></span>
</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>Convert to a formatting list</h1>
<small class="dont-index">Source: <a href="https://github.com/dbosak01/fmtr/blob/HEAD/R/flist.R" class="external-link"><code>R/flist.R</code></a></small>
<div class="hidden name"><code>as.flist.Rd</code></div>
</div>
<div class="ref-description">
<p>Converts an object to a formatting list. All
other parameters are the same as the <code>flist</code> function.</p>
</div>
<div id="ref-usage">
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">as.flist</span><span class="op">(</span><span class="va">x</span>, type <span class="op">=</span> <span class="st">"column"</span>, lookup <span class="op">=</span> <span class="cn">NULL</span>, simplify <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></code></pre></div>
</div>
<div id="arguments">
<h2>Arguments</h2>
<dl><dt>x</dt>
<dd><p>Object to convert.</p></dd>
<dt>type</dt>
<dd><p>The type of formatting list. Valid values are 'row' or 'column'.
The default value is 'column'.</p></dd>
<dt>lookup</dt>
<dd><p>A lookup vector. Used for looking up the format from
the formatting list. This parameter is only used for 'row' type
formatting lists.</p></dd>
<dt>simplify</dt>
<dd><p>Whether to simplify the results to a vector. Valid values
are TRUE or FALSE. Default is TRUE. If the value is set to FALSE, the
return type will be a list.</p></dd>
</dl></div>
<div id="value">
<h2>Value</h2>
<p>A formatting list object.</p>
</div>
<div id="details">
<h2>Details</h2>
<p>To apply more than one formatting object to a vector, use a formatting
list. There are two types of formatting list: column and row. The column
type formatting lists applies all formats to all values in the
vector. The row type formatting list can apply a different format to
each value in the vector.</p>
<p>Further, there are two styles of row type list: ordered and lookup. The
ordered style applies each format in the list to the vector values
in the order specified. The
ordered style will recycle the formats as needed. The lookup style
formatting list uses a lookup to determine which format from the list to
apply to a particular value of the vector. The lookup column values should
correspond to names on the formatting list.</p>
<p>Examples of column type and row type formatting lists are given below.</p>
</div>
<div id="see-also">
<h2>See also</h2>
<div class="dont-index"><p>Other flist:
<code><a href="as.data.frame.fmt_lst.html">as.data.frame.fmt_lst</a>()</code>,
<code><a href="as.flist.data.frame.html">as.flist.data.frame</a>()</code>,
<code><a href="as.flist.fcat.html">as.flist.fcat</a>()</code>,
<code><a href="as.flist.list.html">as.flist.list</a>()</code>,
<code><a href="as.flist.tbl_df.html">as.flist.tbl_df</a>()</code>,
<code><a href="flist.html">flist</a>()</code>,
<code><a href="is.flist.html">is.flist</a>()</code>,
<code><a href="print.fmt_lst.html">print.fmt_lst</a>()</code></p></div>
</div>
<div id="ref-examples">
<h2>Examples</h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="co">## Example 1: Formatting List - Column Type ##</span></span>
<span><span class="co"># Set up data</span></span>
<span><span class="va">v1</span> <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="fu"><a href="https://rdrr.io/r/base/Sys.time.html" class="external-link">Sys.Date</a></span><span class="op">(</span><span class="op">)</span>, <span class="fu"><a href="https://rdrr.io/r/base/Sys.time.html" class="external-link">Sys.Date</a></span><span class="op">(</span><span class="op">)</span> <span class="op">+</span> <span class="fl">30</span>, <span class="fu"><a href="https://rdrr.io/r/base/Sys.time.html" class="external-link">Sys.Date</a></span><span class="op">(</span><span class="op">)</span> <span class="op">+</span> <span class="fl">60</span><span class="op">)</span></span>
<span></span>
<span><span class="co"># Create formatting list</span></span>
<span><span class="va">fl1</span> <span class="op"><-</span> <span class="fu"><a href="flist.html">flist</a></span><span class="op">(</span><span class="st">"%B"</span>, <span class="st">"The month is: %s"</span><span class="op">)</span></span>
<span></span>
<span><span class="co"># Apply formatting list to vector</span></span>
<span><span class="fu"><a href="fapply.html">fapply</a></span><span class="op">(</span><span class="va">v1</span>, <span class="va">fl1</span><span class="op">)</span></span>
<span></span>
<span><span class="co"># [1] "The month is: October" "The month is: November" "The month is: December"</span></span>
<span></span>
<span><span class="co">## Example 2: Formatting List - Row Type ordered ##</span></span>
<span><span class="co"># Set up data</span></span>
<span><span class="co"># Notice each row has a different data type</span></span>
<span><span class="va">l1</span> <span class="op"><-</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="st">"A"</span>, <span class="fl">1.263</span>, <span class="fu"><a href="https://rdrr.io/r/base/as.Date.html" class="external-link">as.Date</a></span><span class="op">(</span><span class="st">"2020-07-21"</span><span class="op">)</span>, </span>
<span> <span class="st">"B"</span>, <span class="fl">5.8732</span>, <span class="fu"><a href="https://rdrr.io/r/base/as.Date.html" class="external-link">as.Date</a></span><span class="op">(</span><span class="st">"2020-10-17"</span><span class="op">)</span><span class="op">)</span></span>
<span> </span>
<span><span class="co"># These formats will be recycled in the order specified </span></span>
<span><span class="va">fl2</span> <span class="op"><-</span> <span class="fu"><a href="flist.html">flist</a></span><span class="op">(</span>type <span class="op">=</span> <span class="st">"row"</span>,</span>
<span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span>A <span class="op">=</span> <span class="st">"Label A"</span>, B <span class="op">=</span> <span class="st">"Label B"</span><span class="op">)</span>,</span>
<span> <span class="st">"%.1f"</span>,</span>
<span> <span class="st">"%d%b%Y"</span><span class="op">)</span></span>
<span></span>
<span><span class="fu"><a href="fapply.html">fapply</a></span><span class="op">(</span><span class="va">l1</span>, <span class="va">fl2</span><span class="op">)</span></span>
<span></span>
<span><span class="co"># [1] "Label A" "1.3" "21Jul2020" "Label B" "5.9" "17Oct2020"</span></span>
<span></span>
<span></span>
<span><span class="co">## Example 3: Formatting List - Row Type with lookup ##</span></span>
<span><span class="co"># Set up data</span></span>
<span><span class="co"># Notice each row has a different data type</span></span>
<span><span class="va">l2</span> <span class="op"><-</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="fl">2841.258</span>, <span class="st">"H"</span>, <span class="fu"><a href="https://rdrr.io/r/base/as.Date.html" class="external-link">as.Date</a></span><span class="op">(</span><span class="st">"2020-06-19"</span><span class="op">)</span>,</span>
<span> <span class="st">"L"</span>, <span class="fu"><a href="https://rdrr.io/r/base/as.Date.html" class="external-link">as.Date</a></span><span class="op">(</span><span class="st">"2020-04-24"</span><span class="op">)</span>, <span class="fl">1382.8865</span><span class="op">)</span></span>
<span><span class="va">v3</span> <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">"num"</span>, <span class="st">"char"</span>, <span class="st">"date"</span>, <span class="st">"char"</span>, <span class="st">"date"</span>, <span class="st">"num"</span><span class="op">)</span></span>
<span></span>
<span><span class="co"># Create formatting list</span></span>
<span><span class="va">fl3</span> <span class="op"><-</span> <span class="fu"><a href="flist.html">flist</a></span><span class="op">(</span>type <span class="op">=</span> <span class="st">"row"</span>, lookup <span class="op">=</span> <span class="va">v3</span>,</span>
<span> num <span class="op">=</span> <span class="kw">function</span><span class="op">(</span><span class="va">x</span><span class="op">)</span> <span class="fu"><a href="https://rdrr.io/r/base/format.html" class="external-link">format</a></span><span class="op">(</span><span class="va">x</span>, digits <span class="op">=</span> <span class="fl">2</span>, nsmall <span class="op">=</span> <span class="fl">1</span>, </span>
<span> big.mark<span class="op">=</span><span class="st">","</span><span class="op">)</span>,</span>
<span> char <span class="op">=</span> <span class="fu"><a href="value.html">value</a></span><span class="op">(</span><span class="fu"><a href="condition.html">condition</a></span><span class="op">(</span><span class="va">x</span> <span class="op">==</span> <span class="st">"H"</span>, <span class="st">"High"</span><span class="op">)</span>,</span>
<span> <span class="fu"><a href="condition.html">condition</a></span><span class="op">(</span><span class="va">x</span> <span class="op">==</span> <span class="st">"L"</span>, <span class="st">"Low"</span><span class="op">)</span>,</span>
<span> <span class="fu"><a href="condition.html">condition</a></span><span class="op">(</span><span class="cn">TRUE</span>, <span class="st">"NA"</span><span class="op">)</span><span class="op">)</span>,</span>
<span> date <span class="op">=</span> <span class="st">"%d%b%Y"</span><span class="op">)</span></span>
<span></span>
<span><span class="co"># Apply formatting list to vector, using lookup</span></span>
<span><span class="fu"><a href="fapply.html">fapply</a></span><span class="op">(</span><span class="va">l2</span>, <span class="va">fl3</span><span class="op">)</span></span>
<span></span>
<span><span class="co"># [1] "2,841.3" "High" "19Jun2020" "Low" "24Apr2020" "1,382.9"</span></span></code></pre></div>
</div>
</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></p><p>Developed by David Bosak.</p>
</div>
<div class="pkgdown">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
</div>
</footer></div>
</body></html>