-
Notifications
You must be signed in to change notification settings - Fork 37
/
index.html
237 lines (215 loc) · 8.59 KB
/
index.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
228
229
230
231
232
233
234
235
236
237
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html>
<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>Function reference • pillar</title>
<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link href="../tidyverse.css" rel="stylesheet">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
<!-- Font Awesome icons -->
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">
<!-- tidyverse -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../jquery.sticky-kit.min.js"></script>
<script src="../pkgdown.js"></script>
<!-- mathjax -->
<script src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></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>
<div class="container template-reference-index">
<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">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<div class="navbar-brand-container">
<a class="navbar-brand" href="../index.html">pillar</a>
<small class="tidyverse">part of the <a href="http://tidyverse.org">tidyverse</a></small>
</div>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li>
<a href="../reference/pillar-package.html#package-options">Options</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
<li>
<a href="../news/index.html">News</a>
</li>
<li>
<a href="https://github.com/r-lib/pillar">
<span class="fa fa-github fa-lg"></span>
</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header>
<div class="row">
<div class="col-md-9">
<div class="page-header">
<h1>
Reference
<small>version 1.2.1</small>
</h1>
</div>
<div class="contents">
<table class="ref-index">
<colgroup>
<col class="alias" />
<col class="title" />
</colgroup>
<tbody>
<tr>
<th colspan="2">
<h2 id="section-high-level-interface" class="hasAnchor"><a href="#section-high-level-interface" class="anchor"></a>High-level interface</h2>
<p class="section-desc"><p>These functions accept vectors or lists and create objects that format nicely on the terminal.</p></p>
</th>
</tr>
<tr>
<!-- -->
<td>
<p><code><a href="pillar.html">pillar</a></code> </p>
</td>
<td><p>Format a vector suitable for tabular display</p></td>
</tr><tr>
<!-- -->
<td>
<p><code><a href="colonnade.html">colonnade</a></code> <code><a href="colonnade.html">squeeze</a></code> </p>
</td>
<td><p>Format multiple vectors in a tabular display</p></td>
</tr><tr>
<!-- -->
<td>
<p><code><a href="extra_cols.html">extra_cols</a></code> </p>
</td>
<td><p>Retrieve information about columns that didn't fit the available width</p></td>
</tr>
</tbody><tbody>
<tr>
<th colspan="2">
<h2 id="section-hooks" class="hasAnchor"><a href="#section-hooks" class="anchor"></a>Hooks</h2>
<p class="section-desc"><p>Override or use these methods if you want pillar support for your data type.</p></p>
</th>
</tr>
<tr>
<!-- -->
<td>
<p><code><a href="pillar_shaft.html">pillar_shaft</a></code> <code><a href="pillar_shaft.html">print</a></code> <code><a href="pillar_shaft.html">format</a></code> </p>
</td>
<td><p>Column data</p></td>
</tr><tr>
<!-- -->
<td>
<p><code><a href="new_pillar_shaft.html">new_pillar_shaft</a></code> <code><a href="new_pillar_shaft.html">new_pillar_shaft_simple</a></code> </p>
</td>
<td><p>Constructor for column data</p></td>
</tr><tr>
<!-- -->
<td>
<p><code><a href="new_ornament.html">new_ornament</a></code> </p>
</td>
<td><p>Helper to define the contents of a pillar</p></td>
</tr>
</tbody><tbody>
<tr>
<th colspan="2">
<h2 id="section-styling" class="hasAnchor"><a href="#section-styling" class="anchor"></a>Styling</h2>
<p class="section-desc"><p>For consistent output among different data types.</p></p>
</th>
</tr>
<tr>
<!-- -->
<td>
<p><code><a href="style_subtle.html">style_num</a></code> <code><a href="style_subtle.html">style_subtle</a></code> <code><a href="style_subtle.html">style_subtle_num</a></code> <code><a href="style_subtle.html">style_bold</a></code> <code><a href="style_subtle.html">style_na</a></code> <code><a href="style_subtle.html">style_neg</a></code> </p>
</td>
<td><p>Styling helpers</p></td>
</tr>
</tbody><tbody>
<tr>
<th colspan="2">
<h2 id="section-miscellaneous" class="hasAnchor"><a href="#section-miscellaneous" class="anchor"></a>Miscellaneous</h2>
<p class="section-desc"></p>
</th>
</tr>
<tr>
<!-- -->
<td>
<p><code><a href="type_sum.html">type_sum</a></code> <code><a href="type_sum.html">obj_sum</a></code> <code><a href="type_sum.html">is_vector_s3</a></code> </p>
</td>
<td><p>Provide a succinct summary of an object</p></td>
</tr><tr>
<!-- -->
<td>
<p><code><a href="dim_desc.html">dim_desc</a></code> </p>
</td>
<td><p>Format dimensions</p></td>
</tr><tr>
<!-- -->
<td>
<p><code><a href="expect_known_display.html">expect_known_display</a></code> </p>
</td>
<td><p>Test helpers</p></td>
</tr><tr>
<!-- -->
<td>
<p><code><a href="get_extent.html">get_extent</a></code> <code><a href="get_extent.html">get_max_extent</a></code> </p>
</td>
<td><p>Calculate display width</p></td>
</tr><tr>
<!-- -->
<td>
<p><code><a href="pillar-package.html">pillar-package</a></code> </p>
</td>
<td><p>pillar: Coloured Formatting for Columns</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#section-high-level-interface">High-level interface</a></li>
<li><a href="#section-hooks">Hooks</a></li>
<li><a href="#section-styling">Styling</a></li>
<li><a href="#section-miscellaneous">Miscellaneous</a></li>
</ul>
</div>
</div>
<footer>
<div class="tidyverse">
<p>pillar is a part of the <strong>tidyverse</strong>, an ecosystem of packages designed with common APIs and a shared philosophy. Learn more at <a href="http://tidyverse.org">tidyverse.org</a>.</p>
</div>
<div class="author">
<p>Developed by Kirill Müller, <a href='http://hadley.nz'>Hadley Wickham</a>.</p>
<p>Site built by <a href="http://pkgdown.r-lib.org">pkgdown</a>.</p>
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-67989-18', 'auto');
ga('send', 'pageview');
</script>
</footer>
</div>
</body>
</html>