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 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
|
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="author" content="Roman Tsegelskyi, Gergely Daróczi" />
<meta name="date" content="2018-11-06" />
<title>Rendering tables with pandoc.table</title>
<style type="text/css">code{white-space: pre;}</style>
<style type="text/css">
a.sourceLine { display: inline-block; line-height: 1.25; }
a.sourceLine { pointer-events: none; color: inherit; text-decoration: inherit; }
a.sourceLine:empty { height: 1.2em; position: absolute; }
.sourceCode { overflow: visible; }
code.sourceCode { white-space: pre; position: relative; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
code.sourceCode { white-space: pre-wrap; }
a.sourceLine { text-indent: -1em; padding-left: 1em; }
}
pre.numberSource a.sourceLine
{ position: relative; }
pre.numberSource a.sourceLine:empty
{ position: absolute; }
pre.numberSource a.sourceLine::before
{ content: attr(data-line-number);
position: absolute; left: -5em; text-align: right; vertical-align: baseline;
border: none; pointer-events: all;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
color: #aaaaaa;
}
pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
div.sourceCode
{ }
@media screen {
a.sourceLine::before { text-decoration: underline; }
}
code span.al { color: #ff0000; font-weight: bold; } /* Alert */
code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code span.at { color: #7d9029; } /* Attribute */
code span.bn { color: #40a070; } /* BaseN */
code span.bu { } /* BuiltIn */
code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code span.ch { color: #4070a0; } /* Char */
code span.cn { color: #880000; } /* Constant */
code span.co { color: #60a0b0; font-style: italic; } /* Comment */
code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code span.do { color: #ba2121; font-style: italic; } /* Documentation */
code span.dt { color: #902000; } /* DataType */
code span.dv { color: #40a070; } /* DecVal */
code span.er { color: #ff0000; font-weight: bold; } /* Error */
code span.ex { } /* Extension */
code span.fl { color: #40a070; } /* Float */
code span.fu { color: #06287e; } /* Function */
code span.im { } /* Import */
code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
code span.kw { color: #007020; font-weight: bold; } /* Keyword */
code span.op { color: #666666; } /* Operator */
code span.ot { color: #007020; } /* Other */
code span.pp { color: #bc7a00; } /* Preprocessor */
code span.sc { color: #4070a0; } /* SpecialChar */
code span.ss { color: #bb6688; } /* SpecialString */
code span.st { color: #4070a0; } /* String */
code span.va { color: #19177c; } /* Variable */
code span.vs { color: #4070a0; } /* VerbatimString */
code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
</style>
<style type="text/css">body {
background-color: #fff;
margin: 1em auto;
max-width: 700px;
overflow: visible;
padding-left: 2em;
padding-right: 2em;
font-family: "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
font-size: 14px;
line-height: 1.35;
}
#header {
text-align: center;
}
#TOC {
clear: both;
margin: 0 0 10px 10px;
padding: 4px;
width: 400px;
border: 1px solid #CCCCCC;
border-radius: 5px;
background-color: #f6f6f6;
font-size: 13px;
line-height: 1.3;
}
#TOC .toctitle {
font-weight: bold;
font-size: 15px;
margin-left: 5px;
}
#TOC ul {
padding-left: 40px;
margin-left: -1.5em;
margin-top: 5px;
margin-bottom: 5px;
}
#TOC ul ul {
margin-left: -2em;
}
#TOC li {
line-height: 16px;
}
table {
margin: 1em auto;
border-width: 1px;
border-color: #DDDDDD;
border-style: outset;
border-collapse: collapse;
}
table th {
border-width: 2px;
padding: 5px;
border-style: inset;
}
table td {
border-width: 1px;
border-style: inset;
line-height: 18px;
padding: 5px 5px;
}
table, table th, table td {
border-left-style: none;
border-right-style: none;
}
table thead, table tr.even {
background-color: #f7f7f7;
}
p {
margin: 0.5em 0;
}
blockquote {
background-color: #f6f6f6;
padding: 0.25em 0.75em;
}
hr {
border-style: solid;
border: none;
border-top: 1px solid #777;
margin: 28px 0;
}
dl {
margin-left: 0;
}
dl dd {
margin-bottom: 13px;
margin-left: 13px;
}
dl dt {
font-weight: bold;
}
ul {
margin-top: 0;
}
ul li {
list-style: circle outside;
}
ul ul {
margin-bottom: 0;
}
pre, code {
background-color: #f7f7f7;
border-radius: 3px;
color: #333;
white-space: pre-wrap;
}
pre {
border-radius: 3px;
margin: 5px 0px 10px 0px;
padding: 10px;
}
pre:not([class]) {
background-color: #f7f7f7;
}
code {
font-family: Consolas, Monaco, 'Courier New', monospace;
font-size: 85%;
}
p > code, li > code {
padding: 2px 0px;
}
div.figure {
text-align: center;
}
img {
background-color: #FFFFFF;
padding: 2px;
border: 1px solid #DDDDDD;
border-radius: 3px;
border: 1px solid #CCCCCC;
margin: 0 5px;
}
h1 {
margin-top: 0;
font-size: 35px;
line-height: 40px;
}
h2 {
border-bottom: 4px solid #f7f7f7;
padding-top: 10px;
padding-bottom: 2px;
font-size: 145%;
}
h3 {
border-bottom: 2px solid #f7f7f7;
padding-top: 10px;
font-size: 120%;
}
h4 {
border-bottom: 1px solid #f7f7f7;
margin-left: 8px;
font-size: 105%;
}
h5, h6 {
border-bottom: 1px solid #ccc;
font-size: 105%;
}
a {
color: #0033dd;
text-decoration: none;
}
a:hover {
color: #6666ff; }
a:visited {
color: #800080; }
a:visited:hover {
color: #BB00BB; }
a[href^="http:"] {
text-decoration: underline; }
a[href^="https:"] {
text-decoration: underline; }
code > span.kw { color: #555; font-weight: bold; }
code > span.dt { color: #902000; }
code > span.dv { color: #40a070; }
code > span.bn { color: #d14; }
code > span.fl { color: #d14; }
code > span.ch { color: #d14; }
code > span.st { color: #d14; }
code > span.co { color: #888888; font-style: italic; }
code > span.ot { color: #007020; }
code > span.al { color: #ff0000; font-weight: bold; }
code > span.fu { color: #900; font-weight: bold; } code > span.er { color: #a61717; background-color: #e3d2d2; }
</style>
</head>
<body>
<h1 class="title toc-ignore">Rendering tables with pandoc.table</h1>
<h4 class="author"><em>Roman Tsegelskyi, Gergely Daróczi</em></h4>
<h4 class="date"><em>2018-11-06</em></h4>
<p>Core functionality of <code>pander</code> is centered around <code>pandoc.table</code>, which is aimed at rendering tables in <code>markdown</code>. In case of 2D tables, <code>pander</code> calls <code>pandoc.table</code> internally, thus in such cases <code>pander</code> and <code>pandoc.table</code> support the same argument and in this vignette will be used iterchangingly. <code>pandoc.table</code> has a wide variety of options (<a href="#highlighting-cells">highlighting</a>, <a href="#table-styles">styles</a>, etc.) and this vignette aims to give a more detailed overview of the most common options. <code>pander</code> comes with a variety of globally adjustable options, which have an effect on the result of your reports. You can query and update these options with the <code>panderOptions</code> function.</p>
<div id="table-styles" class="section level2">
<h2>Table styles</h2>
<p>Since <code>pander</code> aims at rendering R objects into <a href="http://pandoc.org/">Pandoc</a>’s markdown all four (<code>multiline</code>, <code>simple</code>, <code>grid</code>, <code>rmarkdown</code>) of <a href="http://johnmacfarlane.net/pandoc/README.html#tables">Pandoc</a>’s formats are supported. Users are advised to stick with the default <code>multiline</code> style, but if there is a need to change it either specify <code>style</code> argument when calling <code>pander/pandoc.table</code> or change the default <code>style</code> using <code>panderOptions</code>.</p>
<div id="multiline-tables" class="section level3">
<h3>multiline tables</h3>
<p><code>multiline</code> tables allow headers and table rows to span multiple lines of text (but cells that span multiple columns or rows of the table are not supported). Also note that, for simplicity, line breaks are removed from cells by default, so multiline cells are typically the result of <a href="#table-and-cell-width">splitting large cells</a> or setting <code>keep.line.breaks</code> to <code>TRUE</code>:</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb1-1" data-line-number="1">m <-<span class="st"> </span><span class="kw">data.frame</span>(<span class="st">'Value</span><span class="ch">\n</span><span class="st">1'</span>, <span class="st">'Value</span><span class="ch">\n</span><span class="st">2'</span>)</a>
<a class="sourceLine" id="cb1-2" data-line-number="2"><span class="kw">colnames</span>(m) <-<span class="st"> </span><span class="kw">c</span>(<span class="st">'Multiline</span><span class="ch">\n</span><span class="st">Col1'</span>, <span class="st">'Multiline</span><span class="ch">\n</span><span class="st">Col2'</span>)</a>
<a class="sourceLine" id="cb1-3" data-line-number="3"><span class="kw">pandoc.table</span>(m, <span class="dt">keep.line.breaks =</span> <span class="ot">TRUE</span>)</a>
<a class="sourceLine" id="cb1-4" data-line-number="4"><span class="co">#> </span></a>
<a class="sourceLine" id="cb1-5" data-line-number="5"><span class="co">#> -----------------------</span></a>
<a class="sourceLine" id="cb1-6" data-line-number="6"><span class="co">#> Multiline Multiline </span></a>
<a class="sourceLine" id="cb1-7" data-line-number="7"><span class="co">#> Col1 Col2 </span></a>
<a class="sourceLine" id="cb1-8" data-line-number="8"><span class="co">#> ----------- -----------</span></a>
<a class="sourceLine" id="cb1-9" data-line-number="9"><span class="co">#> Value Value </span></a>
<a class="sourceLine" id="cb1-10" data-line-number="10"><span class="co">#> 1 2 </span></a>
<a class="sourceLine" id="cb1-11" data-line-number="11"><span class="co">#> -----------------------</span></a>
<a class="sourceLine" id="cb1-12" data-line-number="12">m <-<span class="st"> </span>mtcars[<span class="dv">1</span><span class="op">:</span><span class="dv">3</span>, <span class="dv">1</span><span class="op">:</span><span class="dv">4</span>]</a>
<a class="sourceLine" id="cb1-13" data-line-number="13"><span class="kw">pandoc.table</span>(m)</a>
<a class="sourceLine" id="cb1-14" data-line-number="14"><span class="co">#> </span></a>
<a class="sourceLine" id="cb1-15" data-line-number="15"><span class="co">#> ---------------------------------------------</span></a>
<a class="sourceLine" id="cb1-16" data-line-number="16"><span class="co">#> mpg cyl disp hp </span></a>
<a class="sourceLine" id="cb1-17" data-line-number="17"><span class="co">#> ------------------- ------ ----- ------ -----</span></a>
<a class="sourceLine" id="cb1-18" data-line-number="18"><span class="co">#> Mazda RX4 21 6 160 110 </span></a>
<a class="sourceLine" id="cb1-19" data-line-number="19"><span class="co">#> </span></a>
<a class="sourceLine" id="cb1-20" data-line-number="20"><span class="co">#> Mazda RX4 Wag 21 6 160 110 </span></a>
<a class="sourceLine" id="cb1-21" data-line-number="21"><span class="co">#> </span></a>
<a class="sourceLine" id="cb1-22" data-line-number="22"><span class="co">#> Datsun 710 22.8 4 108 93 </span></a>
<a class="sourceLine" id="cb1-23" data-line-number="23"><span class="co">#> ---------------------------------------------</span></a></code></pre></div>
</div>
<div id="simple-tables" class="section level3">
<h3>simple tables</h3>
<p><code>simple</code> tables are have more compact syntax that all other styles, but don’t they support multiline cells:</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb2-1" data-line-number="1">m <-<span class="st"> </span>mtcars[<span class="dv">1</span><span class="op">:</span><span class="dv">3</span>, <span class="dv">1</span><span class="op">:</span><span class="dv">4</span>]</a>
<a class="sourceLine" id="cb2-2" data-line-number="2"><span class="kw">pandoc.table</span>(m, <span class="dt">style =</span> <span class="st">'simple'</span>)</a>
<a class="sourceLine" id="cb2-3" data-line-number="3"><span class="co">#> </span></a>
<a class="sourceLine" id="cb2-4" data-line-number="4"><span class="co">#> </span></a>
<a class="sourceLine" id="cb2-5" data-line-number="5"><span class="co">#> mpg cyl disp hp </span></a>
<a class="sourceLine" id="cb2-6" data-line-number="6"><span class="co">#> ------------------- ------ ----- ------ -----</span></a>
<a class="sourceLine" id="cb2-7" data-line-number="7"><span class="co">#> Mazda RX4 21 6 160 110 </span></a>
<a class="sourceLine" id="cb2-8" data-line-number="8"><span class="co">#> Mazda RX4 Wag 21 6 160 110 </span></a>
<a class="sourceLine" id="cb2-9" data-line-number="9"><span class="co">#> Datsun 710 22.8 4 108 93</span></a>
<a class="sourceLine" id="cb2-10" data-line-number="10">m <-<span class="st"> </span><span class="kw">data.frame</span>(<span class="st">'Value</span><span class="ch">\n</span><span class="st">1'</span>, <span class="st">'Value</span><span class="ch">\n</span><span class="st">2'</span>)</a>
<a class="sourceLine" id="cb2-11" data-line-number="11"><span class="kw">colnames</span>(m) <-<span class="st"> </span><span class="kw">c</span>(<span class="st">'Multiline</span><span class="ch">\n</span><span class="st">Col1'</span>, <span class="st">'Multiline</span><span class="ch">\n</span><span class="st">Col2'</span>)</a>
<a class="sourceLine" id="cb2-12" data-line-number="12"><span class="kw">pandoc.table</span>(m, <span class="dt">keep.line.breaks =</span> <span class="ot">TRUE</span>, <span class="dt">style=</span><span class="st">'simple'</span>)</a>
<a class="sourceLine" id="cb2-13" data-line-number="13"><span class="co">#> Error in table.expand(t.colnames, t.width, justify, sep.col): Pandoc does not support newlines in simple or Rmarkdown table format!</span></a></code></pre></div>
</div>
<div id="grid-tables" class="section level3">
<h3>grid tables</h3>
<p><code>grid</code> format is really handy for <code>emacs</code> users (<a href="http://table.sourceforge.net/">Emacs table mod</a>) and it does support block elements (multiple paragraphs, code blocks, lists, etc.) inside cells, but cells can’t span multiple columns or rows. Alignments are not supported for grid tables by most parsers, meaning that even though <code>pander</code> will produce a table with alignment, it will be lost during conversion from <code>markdown</code> to <code>HTML/PDF/DOCX</code>.</p>
<div class="sourceCode" id="cb3"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb3-1" data-line-number="1">m <-<span class="st"> </span>mtcars[<span class="dv">1</span><span class="op">:</span><span class="dv">3</span>, <span class="dv">1</span><span class="op">:</span><span class="dv">4</span>]</a>
<a class="sourceLine" id="cb3-2" data-line-number="2"><span class="kw">pandoc.table</span>(m, <span class="dt">style =</span> <span class="st">'grid'</span>)</a>
<a class="sourceLine" id="cb3-3" data-line-number="3"><span class="co">#> </span></a>
<a class="sourceLine" id="cb3-4" data-line-number="4"><span class="co">#> </span></a>
<a class="sourceLine" id="cb3-5" data-line-number="5"><span class="co">#> +-------------------+------+-----+------+-----+</span></a>
<a class="sourceLine" id="cb3-6" data-line-number="6"><span class="co">#> | | mpg | cyl | disp | hp |</span></a>
<a class="sourceLine" id="cb3-7" data-line-number="7"><span class="co">#> +===================+======+=====+======+=====+</span></a>
<a class="sourceLine" id="cb3-8" data-line-number="8"><span class="co">#> | Mazda RX4 | 21 | 6 | 160 | 110 |</span></a>
<a class="sourceLine" id="cb3-9" data-line-number="9"><span class="co">#> +-------------------+------+-----+------+-----+</span></a>
<a class="sourceLine" id="cb3-10" data-line-number="10"><span class="co">#> | Mazda RX4 Wag | 21 | 6 | 160 | 110 |</span></a>
<a class="sourceLine" id="cb3-11" data-line-number="11"><span class="co">#> +-------------------+------+-----+------+-----+</span></a>
<a class="sourceLine" id="cb3-12" data-line-number="12"><span class="co">#> | Datsun 710 | 22.8 | 4 | 108 | 93 |</span></a>
<a class="sourceLine" id="cb3-13" data-line-number="13"><span class="co">#> +-------------------+------+-----+------+-----+</span></a>
<a class="sourceLine" id="cb3-14" data-line-number="14">m <-<span class="st"> </span><span class="kw">data.frame</span>(<span class="st">'Value</span><span class="ch">\n</span><span class="st">1'</span>, <span class="st">'Value</span><span class="ch">\n</span><span class="st">2'</span>)</a>
<a class="sourceLine" id="cb3-15" data-line-number="15"><span class="kw">colnames</span>(m) <-<span class="st"> </span><span class="kw">c</span>(<span class="st">'Multiline</span><span class="ch">\n</span><span class="st">Col1'</span>, <span class="st">'Multiline</span><span class="ch">\n</span><span class="st">Col2'</span>)</a>
<a class="sourceLine" id="cb3-16" data-line-number="16"><span class="kw">pandoc.table</span>(m, <span class="dt">keep.line.breaks =</span> <span class="ot">TRUE</span>, <span class="dt">style=</span><span class="st">'grid'</span>)</a>
<a class="sourceLine" id="cb3-17" data-line-number="17"><span class="co">#> </span></a>
<a class="sourceLine" id="cb3-18" data-line-number="18"><span class="co">#> </span></a>
<a class="sourceLine" id="cb3-19" data-line-number="19"><span class="co">#> +-----------+-----------+</span></a>
<a class="sourceLine" id="cb3-20" data-line-number="20"><span class="co">#> | Multiline | Multiline |</span></a>
<a class="sourceLine" id="cb3-21" data-line-number="21"><span class="co">#> | Col1 | Col2 |</span></a>
<a class="sourceLine" id="cb3-22" data-line-number="22"><span class="co">#> +===========+===========+</span></a>
<a class="sourceLine" id="cb3-23" data-line-number="23"><span class="co">#> | Value | Value |</span></a>
<a class="sourceLine" id="cb3-24" data-line-number="24"><span class="co">#> | 1 | 2 |</span></a>
<a class="sourceLine" id="cb3-25" data-line-number="25"><span class="co">#> +-----------+-----------+</span></a></code></pre></div>
</div>
<div id="rmarkdown-tables" class="section level3">
<h3>rmarkdown tables</h3>
<p><code>rmarkdown</code> or pipe table format, is often used directly with <code>knitr</code>, since it was supported by the first versions of the <code>markdown</code> package. It is similar to <code>simple</code> table in that multiline cells are also not supported. The beginning and ending pipe characters are optional, but pipes are required between all columns:</p>
<div class="sourceCode" id="cb4"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb4-1" data-line-number="1">m <-<span class="st"> </span>mtcars[<span class="dv">1</span><span class="op">:</span><span class="dv">3</span>, <span class="dv">1</span><span class="op">:</span><span class="dv">4</span>]</a>
<a class="sourceLine" id="cb4-2" data-line-number="2"><span class="kw">pandoc.table</span>(m, <span class="dt">style =</span> <span class="st">'rmarkdown'</span>)</a>
<a class="sourceLine" id="cb4-3" data-line-number="3"><span class="co">#> </span></a>
<a class="sourceLine" id="cb4-4" data-line-number="4"><span class="co">#> </span></a>
<a class="sourceLine" id="cb4-5" data-line-number="5"><span class="co">#> | | mpg | cyl | disp | hp |</span></a>
<a class="sourceLine" id="cb4-6" data-line-number="6"><span class="co">#> |:-----------------:|:----:|:---:|:----:|:---:|</span></a>
<a class="sourceLine" id="cb4-7" data-line-number="7"><span class="co">#> | Mazda RX4 | 21 | 6 | 160 | 110 |</span></a>
<a class="sourceLine" id="cb4-8" data-line-number="8"><span class="co">#> | Mazda RX4 Wag | 21 | 6 | 160 | 110 |</span></a>
<a class="sourceLine" id="cb4-9" data-line-number="9"><span class="co">#> | Datsun 710 | 22.8 | 4 | 108 | 93 |</span></a>
<a class="sourceLine" id="cb4-10" data-line-number="10">m <-<span class="st"> </span><span class="kw">data.frame</span>(<span class="st">'Value</span><span class="ch">\n</span><span class="st">1'</span>, <span class="st">'Value</span><span class="ch">\n</span><span class="st">2'</span>)</a>
<a class="sourceLine" id="cb4-11" data-line-number="11"><span class="kw">colnames</span>(m) <-<span class="st"> </span><span class="kw">c</span>(<span class="st">'Multiline</span><span class="ch">\n</span><span class="st">Col1'</span>, <span class="st">'Multiline</span><span class="ch">\n</span><span class="st">Col2'</span>)</a>
<a class="sourceLine" id="cb4-12" data-line-number="12"><span class="kw">pandoc.table</span>(m, <span class="dt">keep.line.breaks =</span> <span class="ot">TRUE</span>, <span class="dt">style=</span><span class="st">'rmarkdown'</span>)</a>
<a class="sourceLine" id="cb4-13" data-line-number="13"><span class="co">#> Error in table.expand(t.colnames, t.width, justify, sep.col): Pandoc does not support newlines in simple or Rmarkdown table format!</span></a></code></pre></div>
</div>
</div>
<div id="cell-alignment" class="section level2">
<h2>Cell alignment</h2>
<p><code>pander</code> allows users to control cell alignment (<code>left</code>, <code>right</code> or <code>center/centre</code>) in a table directly by setting the <code>justify</code> parameter when calling <code>pander/pandoc.table</code>. Note that it is possible to specify alignment for each column separately by supplying a vector to justify:</p>
<div class="sourceCode" id="cb5"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb5-1" data-line-number="1"><span class="kw">pandoc.table</span>(<span class="kw">head</span>(iris[,<span class="dv">1</span><span class="op">:</span><span class="dv">3</span>], <span class="dv">2</span>), <span class="dt">justify =</span> <span class="st">'right'</span>)</a>
<a class="sourceLine" id="cb5-2" data-line-number="2"><span class="co">#> </span></a>
<a class="sourceLine" id="cb5-3" data-line-number="3"><span class="co">#> -------------------------------------------</span></a>
<a class="sourceLine" id="cb5-4" data-line-number="4"><span class="co">#> Sepal.Length Sepal.Width Petal.Length</span></a>
<a class="sourceLine" id="cb5-5" data-line-number="5"><span class="co">#> -------------- ------------- --------------</span></a>
<a class="sourceLine" id="cb5-6" data-line-number="6"><span class="co">#> 5.1 3.5 1.4</span></a>
<a class="sourceLine" id="cb5-7" data-line-number="7"><span class="co">#> </span></a>
<a class="sourceLine" id="cb5-8" data-line-number="8"><span class="co">#> 4.9 3 1.4</span></a>
<a class="sourceLine" id="cb5-9" data-line-number="9"><span class="co">#> -------------------------------------------</span></a>
<a class="sourceLine" id="cb5-10" data-line-number="10"><span class="kw">pandoc.table</span>(<span class="kw">head</span>(iris[,<span class="dv">1</span><span class="op">:</span><span class="dv">3</span>], <span class="dv">2</span>), <span class="dt">justify =</span> <span class="kw">c</span>(<span class="st">'right'</span>, <span class="st">'center'</span>, <span class="st">'left'</span>))</a>
<a class="sourceLine" id="cb5-11" data-line-number="11"><span class="co">#> </span></a>
<a class="sourceLine" id="cb5-12" data-line-number="12"><span class="co">#> -------------------------------------------</span></a>
<a class="sourceLine" id="cb5-13" data-line-number="13"><span class="co">#> Sepal.Length Sepal.Width Petal.Length </span></a>
<a class="sourceLine" id="cb5-14" data-line-number="14"><span class="co">#> -------------- ------------- --------------</span></a>
<a class="sourceLine" id="cb5-15" data-line-number="15"><span class="co">#> 5.1 3.5 1.4 </span></a>
<a class="sourceLine" id="cb5-16" data-line-number="16"><span class="co">#> </span></a>
<a class="sourceLine" id="cb5-17" data-line-number="17"><span class="co">#> 4.9 3 1.4 </span></a>
<a class="sourceLine" id="cb5-18" data-line-number="18"><span class="co">#> -------------------------------------------</span></a></code></pre></div>
<p>Another way to define alignment is by using a permanent option <code>table.alignment.default/table.alignment.rownames</code> in <code>panderOptions</code> (preferred way) or by using <code>set.alignment</code> function (legacy way of setting alignment for next table or permanently) which support setting alignment separately for cells and rownames:</p>
<div class="sourceCode" id="cb6"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb6-1" data-line-number="1"><span class="kw">set.alignment</span>(<span class="st">'left'</span>, <span class="dt">row.names =</span> <span class="st">'right'</span>) <span class="co"># set only for next table since permanent parameter is falce</span></a>
<a class="sourceLine" id="cb6-2" data-line-number="2"><span class="kw">pandoc.table</span>(mtcars[<span class="dv">1</span><span class="op">:</span><span class="dv">2</span>, <span class="dv">1</span><span class="op">:</span><span class="dv">5</span>])</a>
<a class="sourceLine" id="cb6-3" data-line-number="3"><span class="co">#> </span></a>
<a class="sourceLine" id="cb6-4" data-line-number="4"><span class="co">#> ---------------------------------------------------</span></a>
<a class="sourceLine" id="cb6-5" data-line-number="5"><span class="co">#> mpg cyl disp hp drat </span></a>
<a class="sourceLine" id="cb6-6" data-line-number="6"><span class="co">#> ------------------- ----- ----- ------ ----- ------</span></a>
<a class="sourceLine" id="cb6-7" data-line-number="7"><span class="co">#> Mazda RX4 21 6 160 110 3.9 </span></a>
<a class="sourceLine" id="cb6-8" data-line-number="8"><span class="co">#> </span></a>
<a class="sourceLine" id="cb6-9" data-line-number="9"><span class="co">#> Mazda RX4 Wag 21 6 160 110 3.9 </span></a>
<a class="sourceLine" id="cb6-10" data-line-number="10"><span class="co">#> ---------------------------------------------------</span></a></code></pre></div>
<p>Interesting application for this functionality is specifying a function that takes the R object as its argument to compute some unique alignment for your table based on e.g. column values or variable types:</p>
<div class="sourceCode" id="cb7"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb7-1" data-line-number="1"><span class="kw">panderOptions</span>(<span class="st">'table.alignment.default'</span>,</a>
<a class="sourceLine" id="cb7-2" data-line-number="2"> <span class="cf">function</span>(df)</a>
<a class="sourceLine" id="cb7-3" data-line-number="3"> <span class="kw">ifelse</span>(<span class="kw">sapply</span>(df, mean) <span class="op">></span><span class="st"> </span><span class="dv">2</span>, <span class="st">'left'</span>, <span class="st">'right'</span>))</a>
<a class="sourceLine" id="cb7-4" data-line-number="4"><span class="kw">pandoc.table</span>(<span class="kw">head</span>(iris[,<span class="dv">1</span><span class="op">:</span><span class="dv">3</span>], <span class="dv">2</span>))</a>
<a class="sourceLine" id="cb7-5" data-line-number="5"><span class="co">#> </span></a>
<a class="sourceLine" id="cb7-6" data-line-number="6"><span class="co">#> -------------------------------------------</span></a>
<a class="sourceLine" id="cb7-7" data-line-number="7"><span class="co">#> Sepal.Length Sepal.Width Petal.Length</span></a>
<a class="sourceLine" id="cb7-8" data-line-number="8"><span class="co">#> -------------- ------------- --------------</span></a>
<a class="sourceLine" id="cb7-9" data-line-number="9"><span class="co">#> 5.1 3.5 1.4</span></a>
<a class="sourceLine" id="cb7-10" data-line-number="10"><span class="co">#> </span></a>
<a class="sourceLine" id="cb7-11" data-line-number="11"><span class="co">#> 4.9 3 1.4</span></a>
<a class="sourceLine" id="cb7-12" data-line-number="12"><span class="co">#> -------------------------------------------</span></a>
<a class="sourceLine" id="cb7-13" data-line-number="13"><span class="kw">panderOptions</span>(<span class="st">'table.alignment.default'</span>, <span class="st">'center'</span>)</a></code></pre></div>
</div>
<div id="highlighting-cells" class="section level2">
<h2>Highlighting cells</h2>
<p>One of the great features of <code>pander</code> is the ease of highlighting rows, columns and cells in a table. This is a native <code>markdown</code> feature without custom <code>HTML</code> or <code>LaTeX</code>-only tweaks, so all <code>HTML/PDF/MS Word/OpenOffice</code> etc. formats are supported.</p>
<p>This can be achieved by specifying one of the arguments below when calling <code>pander</code>/<code>pandoc.table</code> or change default style using <code>panderOptions</code>:</p>
<ul>
<li>emphasize.italics.rows</li>
<li>emphasize.italics.cols</li>
<li>emphasize.italics.cells</li>
<li>emphasize.strong.rows</li>
<li>emphasize.strong.cols</li>
<li>emphasize.strong.cells</li>
<li>emphasize.verbatim.rows</li>
<li>emphasize.verbatim.cols</li>
<li>emphasize.verbatim.cells</li>
</ul>
<p>The <code>emphasize.italics</code> helpers would turn the affected cells to <em>italic</em>, <code>emphasize.strong</code> would apply a <strong>bold</strong> style to the cell and <code>emphasize.verbatim</code> would apply a <code>verbatim</code> style to the cell. A cell can be also <em>italic</em>, <strong>bold</strong> and <code>verbatim</code> at the same time.</p>
<p>Those functions and arguments ending in rows or cols take a vector (like which columns or rows to emphasize in a table), while the cells argument take either a vector (for one dimensional “tables”) or an array-like data structure with two columns holding row and column indexes of cells to be emphasized – just like what <code>which(..., arr.ind = TRUE)</code> returns:</p>
<div class="sourceCode" id="cb8"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb8-1" data-line-number="1">t <-<span class="st"> </span>mtcars[<span class="dv">1</span><span class="op">:</span><span class="dv">3</span>, <span class="dv">1</span><span class="op">:</span><span class="dv">5</span>]</a>
<a class="sourceLine" id="cb8-2" data-line-number="2"><span class="kw">emphasize.italics.cols</span>(<span class="dv">1</span>)</a>
<a class="sourceLine" id="cb8-3" data-line-number="3"><span class="kw">emphasize.italics.rows</span>(<span class="dv">1</span>)</a>
<a class="sourceLine" id="cb8-4" data-line-number="4"><span class="kw">emphasize.strong.cells</span>(<span class="kw">which</span>(t <span class="op">></span><span class="st"> </span><span class="dv">20</span>, <span class="dt">arr.ind =</span> <span class="ot">TRUE</span>))</a>
<a class="sourceLine" id="cb8-5" data-line-number="5"><span class="kw">pandoc.table</span>(t)</a>
<a class="sourceLine" id="cb8-6" data-line-number="6"><span class="co">#> </span></a>
<a class="sourceLine" id="cb8-7" data-line-number="7"><span class="co">#> ----------------------------------------------------</span></a>
<a class="sourceLine" id="cb8-8" data-line-number="8"><span class="co">#> mpg cyl disp hp drat </span></a>
<a class="sourceLine" id="cb8-9" data-line-number="9"><span class="co">#> ------------------- ------ ----- ------ ----- ------</span></a>
<a class="sourceLine" id="cb8-10" data-line-number="10"><span class="co">#> Mazda RX4 21 6 160 110 3.9 </span></a>
<a class="sourceLine" id="cb8-11" data-line-number="11"><span class="co">#> </span></a>
<a class="sourceLine" id="cb8-12" data-line-number="12"><span class="co">#> Mazda RX4 Wag 21 6 160 110 3.9 </span></a>
<a class="sourceLine" id="cb8-13" data-line-number="13"><span class="co">#> </span></a>
<a class="sourceLine" id="cb8-14" data-line-number="14"><span class="co">#> Datsun 710 22.8 4 108 93 3.85 </span></a>
<a class="sourceLine" id="cb8-15" data-line-number="15"><span class="co">#> ----------------------------------------------------</span></a>
<a class="sourceLine" id="cb8-16" data-line-number="16"><span class="kw">pandoc.table</span>(t, <span class="dt">emphasize.verbatim.rows =</span> <span class="dv">1</span>, <span class="dt">emphasize.strong.cells =</span> <span class="kw">which</span>(t <span class="op">></span><span class="st"> </span><span class="dv">20</span>, <span class="dt">arr.ind =</span> <span class="ot">TRUE</span>))</a>
<a class="sourceLine" id="cb8-17" data-line-number="17"><span class="co">#> </span></a>
<a class="sourceLine" id="cb8-18" data-line-number="18"><span class="co">#> ----------------------------------------------------</span></a>
<a class="sourceLine" id="cb8-19" data-line-number="19"><span class="co">#> mpg cyl disp hp drat </span></a>
<a class="sourceLine" id="cb8-20" data-line-number="20"><span class="co">#> ------------------- ------ ----- ------ ----- ------</span></a>
<a class="sourceLine" id="cb8-21" data-line-number="21"><span class="co">#> Mazda RX4 21 6 160 110 3.9 </span></a>
<a class="sourceLine" id="cb8-22" data-line-number="22"><span class="co">#> </span></a>
<a class="sourceLine" id="cb8-23" data-line-number="23"><span class="co">#> Mazda RX4 Wag 21 6 160 110 3.9 </span></a>
<a class="sourceLine" id="cb8-24" data-line-number="24"><span class="co">#> </span></a>
<a class="sourceLine" id="cb8-25" data-line-number="25"><span class="co">#> Datsun 710 22.8 4 108 93 3.85 </span></a>
<a class="sourceLine" id="cb8-26" data-line-number="26"><span class="co">#> ----------------------------------------------------</span></a></code></pre></div>
<p>For more elaborative examples, please see our blog post - <a href="http://blog.rapporter.net/2013/04/hihglight-cells-in-markdown-tables.html">Highlight cells in markdown tables</a>.</p>
</div>
<div id="table-and-cell-width" class="section level2">
<h2>Table and Cell width</h2>
<p><code>pander/pandoc.table</code> is able to deal with wide tables. Ever had an issue in <code>LaTeX</code> or <code>MS Word</code> when trying to print a correlation matrix of 40 variables? This problem is carefully addressed with <code>split.table</code> parameter:</p>
<div class="sourceCode" id="cb9"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb9-1" data-line-number="1"><span class="kw">pandoc.table</span>(mtcars[<span class="dv">1</span><span class="op">:</span><span class="dv">2</span>, ], <span class="dt">style =</span> <span class="st">"grid"</span>, <span class="dt">caption =</span> <span class="st">"Wide table to be split!"</span>)</a>
<a class="sourceLine" id="cb9-2" data-line-number="2"><span class="co">#> </span></a>
<a class="sourceLine" id="cb9-3" data-line-number="3"><span class="co">#> </span></a>
<a class="sourceLine" id="cb9-4" data-line-number="4"><span class="co">#> +-------------------+-----+-----+------+-----+------+-------+-------+</span></a>
<a class="sourceLine" id="cb9-5" data-line-number="5"><span class="co">#> | | mpg | cyl | disp | hp | drat | wt | qsec |</span></a>
<a class="sourceLine" id="cb9-6" data-line-number="6"><span class="co">#> +===================+=====+=====+======+=====+======+=======+=======+</span></a>
<a class="sourceLine" id="cb9-7" data-line-number="7"><span class="co">#> | Mazda RX4 | 21 | 6 | 160 | 110 | 3.9 | 2.62 | 16.46 |</span></a>
<a class="sourceLine" id="cb9-8" data-line-number="8"><span class="co">#> +-------------------+-----+-----+------+-----+------+-------+-------+</span></a>
<a class="sourceLine" id="cb9-9" data-line-number="9"><span class="co">#> | Mazda RX4 Wag | 21 | 6 | 160 | 110 | 3.9 | 2.875 | 17.02 |</span></a>
<a class="sourceLine" id="cb9-10" data-line-number="10"><span class="co">#> +-------------------+-----+-----+------+-----+------+-------+-------+</span></a>
<a class="sourceLine" id="cb9-11" data-line-number="11"><span class="co">#> </span></a>
<a class="sourceLine" id="cb9-12" data-line-number="12"><span class="co">#> Table: Wide table to be split! (continued below)</span></a>
<a class="sourceLine" id="cb9-13" data-line-number="13"><span class="co">#> </span></a>
<a class="sourceLine" id="cb9-14" data-line-number="14"><span class="co">#> </span></a>
<a class="sourceLine" id="cb9-15" data-line-number="15"><span class="co">#> </span></a>
<a class="sourceLine" id="cb9-16" data-line-number="16"><span class="co">#> +-------------------+----+----+------+------+</span></a>
<a class="sourceLine" id="cb9-17" data-line-number="17"><span class="co">#> | | vs | am | gear | carb |</span></a>
<a class="sourceLine" id="cb9-18" data-line-number="18"><span class="co">#> +===================+====+====+======+======+</span></a>
<a class="sourceLine" id="cb9-19" data-line-number="19"><span class="co">#> | Mazda RX4 | 0 | 1 | 4 | 4 |</span></a>
<a class="sourceLine" id="cb9-20" data-line-number="20"><span class="co">#> +-------------------+----+----+------+------+</span></a>
<a class="sourceLine" id="cb9-21" data-line-number="21"><span class="co">#> | Mazda RX4 Wag | 0 | 1 | 4 | 4 |</span></a>
<a class="sourceLine" id="cb9-22" data-line-number="22"><span class="co">#> +-------------------+----+----+------+------+</span></a></code></pre></div>
<p><code>split.table</code> defaults to 80 characters and to turn it off, set <code>split.table</code> to <code>Inf</code>:</p>
<div class="sourceCode" id="cb10"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb10-1" data-line-number="1"><span class="kw">pandoc.table</span>(mtcars[<span class="dv">1</span><span class="op">:</span><span class="dv">2</span>, ], <span class="dt">style =</span> <span class="st">"grid"</span>,</a>
<a class="sourceLine" id="cb10-2" data-line-number="2"> <span class="dt">caption =</span> <span class="st">"Wide table to be split!"</span>, <span class="dt">split.table =</span> <span class="ot">Inf</span>)</a>
<a class="sourceLine" id="cb10-3" data-line-number="3"><span class="co">#> </span></a>
<a class="sourceLine" id="cb10-4" data-line-number="4"><span class="co">#> </span></a>
<a class="sourceLine" id="cb10-5" data-line-number="5"><span class="co">#> +-------------------+-----+-----+------+-----+------+-------+-------+----+----+------+------+</span></a>
<a class="sourceLine" id="cb10-6" data-line-number="6"><span class="co">#> | | mpg | cyl | disp | hp | drat | wt | qsec | vs | am | gear | carb |</span></a>
<a class="sourceLine" id="cb10-7" data-line-number="7"><span class="co">#> +===================+=====+=====+======+=====+======+=======+=======+====+====+======+======+</span></a>
<a class="sourceLine" id="cb10-8" data-line-number="8"><span class="co">#> | Mazda RX4 | 21 | 6 | 160 | 110 | 3.9 | 2.62 | 16.46 | 0 | 1 | 4 | 4 |</span></a>
<a class="sourceLine" id="cb10-9" data-line-number="9"><span class="co">#> +-------------------+-----+-----+------+-----+------+-------+-------+----+----+------+------+</span></a>
<a class="sourceLine" id="cb10-10" data-line-number="10"><span class="co">#> | Mazda RX4 Wag | 21 | 6 | 160 | 110 | 3.9 | 2.875 | 17.02 | 0 | 1 | 4 | 4 |</span></a>
<a class="sourceLine" id="cb10-11" data-line-number="11"><span class="co">#> +-------------------+-----+-----+------+-----+------+-------+-------+----+----+------+------+</span></a>
<a class="sourceLine" id="cb10-12" data-line-number="12"><span class="co">#> </span></a>
<a class="sourceLine" id="cb10-13" data-line-number="13"><span class="co">#> Table: Wide table to be split!</span></a></code></pre></div>
<p>Also, <code>pander</code> tries to split too wide cells into multiline cells. The maximum number of characters in a cell is specified by the <code>split.cells</code> parameter (defaults to 30), which can be a single value, vector (values for each column separately) and relative vector (percentages of <code>split.tables</code> parameter). Please not that this only works for <code>multiline</code> and <code>grid</code> tables:</p>
<div class="sourceCode" id="cb11"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb11-1" data-line-number="1">df <-<span class="st"> </span><span class="kw">data.frame</span>(<span class="dt">a =</span> <span class="st">'Lorem ipsum'</span>, <span class="dt">b =</span> <span class="st">'dolor sit'</span>, <span class="dt">c =</span> <span class="st">'amet'</span>)</a>
<a class="sourceLine" id="cb11-2" data-line-number="2"><span class="kw">pandoc.table</span>(df, <span class="dt">split.cells =</span> <span class="dv">5</span>)</a>
<a class="sourceLine" id="cb11-3" data-line-number="3"><span class="co">#> </span></a>
<a class="sourceLine" id="cb11-4" data-line-number="4"><span class="co">#> ----------------------</span></a>
<a class="sourceLine" id="cb11-5" data-line-number="5"><span class="co">#> a b c </span></a>
<a class="sourceLine" id="cb11-6" data-line-number="6"><span class="co">#> ------- ------- ------</span></a>
<a class="sourceLine" id="cb11-7" data-line-number="7"><span class="co">#> Lorem dolor amet </span></a>
<a class="sourceLine" id="cb11-8" data-line-number="8"><span class="co">#> ipsum sit </span></a>
<a class="sourceLine" id="cb11-9" data-line-number="9"><span class="co">#> ----------------------</span></a>
<a class="sourceLine" id="cb11-10" data-line-number="10"><span class="kw">pandoc.table</span>(df, <span class="dt">split.cells =</span> <span class="kw">c</span>(<span class="dv">5</span>, <span class="dv">20</span>, <span class="dv">5</span>))</a>
<a class="sourceLine" id="cb11-11" data-line-number="11"><span class="co">#> </span></a>
<a class="sourceLine" id="cb11-12" data-line-number="12"><span class="co">#> --------------------------</span></a>
<a class="sourceLine" id="cb11-13" data-line-number="13"><span class="co">#> a b c </span></a>
<a class="sourceLine" id="cb11-14" data-line-number="14"><span class="co">#> ------- ----------- ------</span></a>
<a class="sourceLine" id="cb11-15" data-line-number="15"><span class="co">#> Lorem dolor sit amet </span></a>
<a class="sourceLine" id="cb11-16" data-line-number="16"><span class="co">#> ipsum </span></a>
<a class="sourceLine" id="cb11-17" data-line-number="17"><span class="co">#> --------------------------</span></a>
<a class="sourceLine" id="cb11-18" data-line-number="18"><span class="kw">pandoc.table</span>(df, <span class="dt">split.cells =</span> <span class="kw">c</span>(<span class="st">"80%"</span>, <span class="st">"10%"</span>, <span class="st">"10%"</span>))</a>
<a class="sourceLine" id="cb11-19" data-line-number="19"><span class="co">#> </span></a>
<a class="sourceLine" id="cb11-20" data-line-number="20"><span class="co">#> ----------------------------</span></a>
<a class="sourceLine" id="cb11-21" data-line-number="21"><span class="co">#> a b c </span></a>
<a class="sourceLine" id="cb11-22" data-line-number="22"><span class="co">#> ------------- ------- ------</span></a>
<a class="sourceLine" id="cb11-23" data-line-number="23"><span class="co">#> Lorem ipsum dolor amet </span></a>
<a class="sourceLine" id="cb11-24" data-line-number="24"><span class="co">#> sit </span></a>
<a class="sourceLine" id="cb11-25" data-line-number="25"><span class="co">#> ----------------------------</span></a>
<a class="sourceLine" id="cb11-26" data-line-number="26"><span class="kw">pandoc.table</span>(df, <span class="dt">split.cells =</span> <span class="dv">5</span>, <span class="dt">style =</span> <span class="st">'simple'</span>)</a>
<a class="sourceLine" id="cb11-27" data-line-number="27"><span class="co">#> </span></a>
<a class="sourceLine" id="cb11-28" data-line-number="28"><span class="co">#> </span></a>
<a class="sourceLine" id="cb11-29" data-line-number="29"><span class="co">#> a b c </span></a>
<a class="sourceLine" id="cb11-30" data-line-number="30"><span class="co">#> ------------- ----------- ------</span></a>
<a class="sourceLine" id="cb11-31" data-line-number="31"><span class="co">#> Lorem ipsum dolor sit amet</span></a></code></pre></div>
<p>In some cases it is also useful to split too long words with hyphens, and <code>pander</code> uses <code>sylly</code> functionality for that. Just specify <code>use.hyphening</code> argument and have <code>sylly</code> installed:</p>
<div class="sourceCode" id="cb12"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb12-1" data-line-number="1"><span class="kw">pandoc.table</span>(<span class="kw">data.frame</span>(<span class="dt">baz =</span> <span class="st">'foobar'</span>, <span class="dt">foo=</span><span class="st">'accoutrements'</span>),</a>
<a class="sourceLine" id="cb12-2" data-line-number="2"> <span class="dt">use.hyphening =</span> <span class="ot">TRUE</span>, <span class="dt">split.cells =</span> <span class="dv">3</span>)</a>
<a class="sourceLine" id="cb12-3" data-line-number="3"><span class="co">#> </span></a>
<a class="sourceLine" id="cb12-4" data-line-number="4"><span class="co">#> --------------</span></a>
<a class="sourceLine" id="cb12-5" data-line-number="5"><span class="co">#> baz foo </span></a>
<a class="sourceLine" id="cb12-6" data-line-number="6"><span class="co">#> ------ -------</span></a>
<a class="sourceLine" id="cb12-7" data-line-number="7"><span class="co">#> foo- ac- </span></a>
<a class="sourceLine" id="cb12-8" data-line-number="8"><span class="co">#> bar cou- </span></a>
<a class="sourceLine" id="cb12-9" data-line-number="9"><span class="co">#> tre- </span></a>
<a class="sourceLine" id="cb12-10" data-line-number="10"><span class="co">#> ments </span></a>
<a class="sourceLine" id="cb12-11" data-line-number="11"><span class="co">#> --------------</span></a></code></pre></div>
</div>
<div id="rounding-and-number-formatting" class="section level2">
<h2>Rounding and number formatting</h2>
<p><code>pander/pandoc.table</code> deals with formatting numbers by having 4 parameters:</p>
<ul>
<li><code>round</code> to the number of decimal places.</li>
<li><code>digits</code> to specify how many significant digits are to be used for numeric</li>
<li><code>decimal.mark/big.mark</code> to specify character for decimal point/orders of magnitude</li>
</ul>
<p><code>round</code> and <code>digits</code> parameter can be a vector specifying values for each column (has to be the same length as number of columns). Values for non-numeric columns will be disregarded.</p>
<p>Now let’s get to some examples:</p>
<div class="sourceCode" id="cb13"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb13-1" data-line-number="1">r <-<span class="st"> </span><span class="kw">matrix</span>(<span class="kw">c</span>(<span class="fl">283764.97430</span>, <span class="fl">29.12345678901</span>, <span class="fl">-7.1234</span>, <span class="fl">-100.1</span>), <span class="dt">ncol =</span> <span class="dv">2</span>)</a>
<a class="sourceLine" id="cb13-2" data-line-number="2"><span class="kw">pandoc.table</span>(r, <span class="dt">round =</span> <span class="dv">2</span>)</a>
<a class="sourceLine" id="cb13-3" data-line-number="3"><span class="co">#> </span></a>
<a class="sourceLine" id="cb13-4" data-line-number="4"><span class="co">#> -------- --------</span></a>
<a class="sourceLine" id="cb13-5" data-line-number="5"><span class="co">#> 283765 -7.12 </span></a>
<a class="sourceLine" id="cb13-6" data-line-number="6"><span class="co">#> </span></a>
<a class="sourceLine" id="cb13-7" data-line-number="7"><span class="co">#> 29.12 -100.1 </span></a>
<a class="sourceLine" id="cb13-8" data-line-number="8"><span class="co">#> -------- --------</span></a>
<a class="sourceLine" id="cb13-9" data-line-number="9"><span class="kw">pandoc.table</span>(r, <span class="dt">round =</span> <span class="kw">c</span>(<span class="dv">4</span>,<span class="dv">2</span>)) <span class="co"># vector for each column</span></a>
<a class="sourceLine" id="cb13-10" data-line-number="10"><span class="co">#> </span></a>
<a class="sourceLine" id="cb13-11" data-line-number="11"><span class="co">#> -------- --------</span></a>
<a class="sourceLine" id="cb13-12" data-line-number="12"><span class="co">#> 283765 -7.12 </span></a>
<a class="sourceLine" id="cb13-13" data-line-number="13"><span class="co">#> </span></a>
<a class="sourceLine" id="cb13-14" data-line-number="14"><span class="co">#> 29.12 -100.1 </span></a>
<a class="sourceLine" id="cb13-15" data-line-number="15"><span class="co">#> -------- --------</span></a>
<a class="sourceLine" id="cb13-16" data-line-number="16"><span class="kw">pandoc.table</span>(r, <span class="dt">digits =</span> <span class="dv">2</span>)</a>
<a class="sourceLine" id="cb13-17" data-line-number="17"><span class="co">#> </span></a>
<a class="sourceLine" id="cb13-18" data-line-number="18"><span class="co">#> -------- ------</span></a>
<a class="sourceLine" id="cb13-19" data-line-number="19"><span class="co">#> 283765 -7.1 </span></a>
<a class="sourceLine" id="cb13-20" data-line-number="20"><span class="co">#> </span></a>
<a class="sourceLine" id="cb13-21" data-line-number="21"><span class="co">#> 29 -100 </span></a>
<a class="sourceLine" id="cb13-22" data-line-number="22"><span class="co">#> -------- ------</span></a>
<a class="sourceLine" id="cb13-23" data-line-number="23"><span class="kw">pandoc.table</span>(r, <span class="dt">digits =</span> <span class="kw">c</span>(<span class="dv">0</span>, <span class="dv">5</span>)) <span class="co"># vector for each column</span></a>
<a class="sourceLine" id="cb13-24" data-line-number="24"><span class="co">#> </span></a>
<a class="sourceLine" id="cb13-25" data-line-number="25"><span class="co">#> ---------- ---------</span></a>
<a class="sourceLine" id="cb13-26" data-line-number="26"><span class="co">#> %#0.0-1e -7.1234 </span></a>
<a class="sourceLine" id="cb13-27" data-line-number="27"><span class="co">#> </span></a>
<a class="sourceLine" id="cb13-28" data-line-number="28"><span class="co">#> 29 -100.1 </span></a>
<a class="sourceLine" id="cb13-29" data-line-number="29"><span class="co">#> ---------- ---------</span></a>
<a class="sourceLine" id="cb13-30" data-line-number="30"><span class="kw">pandoc.table</span>(r, <span class="dt">big.mark =</span> <span class="st">','</span>)</a>
<a class="sourceLine" id="cb13-31" data-line-number="31"><span class="co">#> </span></a>
<a class="sourceLine" id="cb13-32" data-line-number="32"><span class="co">#> --------- --------</span></a>
<a class="sourceLine" id="cb13-33" data-line-number="33"><span class="co">#> 283,765 -7.123 </span></a>
<a class="sourceLine" id="cb13-34" data-line-number="34"><span class="co">#> </span></a>
<a class="sourceLine" id="cb13-35" data-line-number="35"><span class="co">#> 29.12 -100.1 </span></a>
<a class="sourceLine" id="cb13-36" data-line-number="36"><span class="co">#> --------- --------</span></a>
<a class="sourceLine" id="cb13-37" data-line-number="37"><span class="kw">pandoc.table</span>(r, <span class="dt">decimal.mark =</span> <span class="st">','</span>)</a>
<a class="sourceLine" id="cb13-38" data-line-number="38"><span class="co">#> </span></a>
<a class="sourceLine" id="cb13-39" data-line-number="39"><span class="co">#> -------- --------</span></a>
<a class="sourceLine" id="cb13-40" data-line-number="40"><span class="co">#> 283765 -7,123 </span></a>
<a class="sourceLine" id="cb13-41" data-line-number="41"><span class="co">#> </span></a>
<a class="sourceLine" id="cb13-42" data-line-number="42"><span class="co">#> 29,12 -100,1 </span></a>
<a class="sourceLine" id="cb13-43" data-line-number="43"><span class="co">#> -------- --------</span></a></code></pre></div>
</div>
<div id="other-options" class="section level2">
<h2>Other options</h2>
<p>Functionality described in other sections is most notable, but <code>pander/pandoc.table</code> also has smaller nifty features that are worth mentioning:</p>
<ul>
<li><code>plain.ascii</code> - allows to have the output without <code>markdown</code> markup:</li>
</ul>
<div class="sourceCode" id="cb14"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb14-1" data-line-number="1"><span class="kw">pandoc.table</span>(mtcars[<span class="dv">1</span><span class="op">:</span><span class="dv">3</span>, <span class="dv">1</span><span class="op">:</span><span class="dv">4</span>])</a>
<a class="sourceLine" id="cb14-2" data-line-number="2"><span class="co">#> </span></a>
<a class="sourceLine" id="cb14-3" data-line-number="3"><span class="co">#> ---------------------------------------------</span></a>
<a class="sourceLine" id="cb14-4" data-line-number="4"><span class="co">#> mpg cyl disp hp </span></a>
<a class="sourceLine" id="cb14-5" data-line-number="5"><span class="co">#> ------------------- ------ ----- ------ -----</span></a>
<a class="sourceLine" id="cb14-6" data-line-number="6"><span class="co">#> Mazda RX4 21 6 160 110 </span></a>
<a class="sourceLine" id="cb14-7" data-line-number="7"><span class="co">#> </span></a>
<a class="sourceLine" id="cb14-8" data-line-number="8"><span class="co">#> Mazda RX4 Wag 21 6 160 110 </span></a>
<a class="sourceLine" id="cb14-9" data-line-number="9"><span class="co">#> </span></a>
<a class="sourceLine" id="cb14-10" data-line-number="10"><span class="co">#> Datsun 710 22.8 4 108 93 </span></a>
<a class="sourceLine" id="cb14-11" data-line-number="11"><span class="co">#> ---------------------------------------------</span></a>
<a class="sourceLine" id="cb14-12" data-line-number="12"><span class="kw">pandoc.table</span>(mtcars[<span class="dv">1</span><span class="op">:</span><span class="dv">3</span>, <span class="dv">1</span><span class="op">:</span><span class="dv">4</span>], <span class="dt">plain.ascii =</span> <span class="ot">TRUE</span>)</a>
<a class="sourceLine" id="cb14-13" data-line-number="13"><span class="co">#> </span></a>
<a class="sourceLine" id="cb14-14" data-line-number="14"><span class="co">#> ---------------------------------------------</span></a>
<a class="sourceLine" id="cb14-15" data-line-number="15"><span class="co">#> mpg cyl disp hp </span></a>
<a class="sourceLine" id="cb14-16" data-line-number="16"><span class="co">#> ------------------- ------ ----- ------ -----</span></a>
<a class="sourceLine" id="cb14-17" data-line-number="17"><span class="co">#> Mazda RX4 21 6 160 110 </span></a>
<a class="sourceLine" id="cb14-18" data-line-number="18"><span class="co">#> </span></a>
<a class="sourceLine" id="cb14-19" data-line-number="19"><span class="co">#> Mazda RX4 Wag 21 6 160 110 </span></a>
<a class="sourceLine" id="cb14-20" data-line-number="20"><span class="co">#> </span></a>
<a class="sourceLine" id="cb14-21" data-line-number="21"><span class="co">#> Datsun 710 22.8 4 108 93 </span></a>
<a class="sourceLine" id="cb14-22" data-line-number="22"><span class="co">#> ---------------------------------------------</span></a></code></pre></div>
<ul>
<li><code>caption</code> - set caption (string) to be shown under the table:</li>
</ul>
<div class="sourceCode" id="cb15"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb15-1" data-line-number="1"><span class="kw">pandoc.table</span>(mtcars[<span class="dv">1</span><span class="op">:</span><span class="dv">3</span>, <span class="dv">1</span><span class="op">:</span><span class="dv">5</span>], <span class="dt">style =</span> <span class="st">"grid"</span>, <span class="dt">caption =</span> <span class="st">"My caption!"</span>)</a>
<a class="sourceLine" id="cb15-2" data-line-number="2"><span class="co">#> </span></a>
<a class="sourceLine" id="cb15-3" data-line-number="3"><span class="co">#> </span></a>
<a class="sourceLine" id="cb15-4" data-line-number="4"><span class="co">#> +-------------------+------+-----+------+-----+------+</span></a>
<a class="sourceLine" id="cb15-5" data-line-number="5"><span class="co">#> | | mpg | cyl | disp | hp | drat |</span></a>
<a class="sourceLine" id="cb15-6" data-line-number="6"><span class="co">#> +===================+======+=====+======+=====+======+</span></a>
<a class="sourceLine" id="cb15-7" data-line-number="7"><span class="co">#> | Mazda RX4 | 21 | 6 | 160 | 110 | 3.9 |</span></a>
<a class="sourceLine" id="cb15-8" data-line-number="8"><span class="co">#> +-------------------+------+-----+------+-----+------+</span></a>
<a class="sourceLine" id="cb15-9" data-line-number="9"><span class="co">#> | Mazda RX4 Wag | 21 | 6 | 160 | 110 | 3.9 |</span></a>
<a class="sourceLine" id="cb15-10" data-line-number="10"><span class="co">#> +-------------------+------+-----+------+-----+------+</span></a>
<a class="sourceLine" id="cb15-11" data-line-number="11"><span class="co">#> | Datsun 710 | 22.8 | 4 | 108 | 93 | 3.85 |</span></a>
<a class="sourceLine" id="cb15-12" data-line-number="12"><span class="co">#> +-------------------+------+-----+------+-----+------+</span></a>
<a class="sourceLine" id="cb15-13" data-line-number="13"><span class="co">#> </span></a>
<a class="sourceLine" id="cb15-14" data-line-number="14"><span class="co">#> Table: My caption!</span></a></code></pre></div>
<ul>
<li><code>missing</code> - set a string to replace missing values:</li>
</ul>
<div class="sourceCode" id="cb16"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb16-1" data-line-number="1">m <-<span class="st"> </span>mtcars[<span class="dv">1</span><span class="op">:</span><span class="dv">3</span>, <span class="dv">1</span><span class="op">:</span><span class="dv">5</span>]</a>
<a class="sourceLine" id="cb16-2" data-line-number="2">m<span class="op">$</span>mpg <-<span class="st"> </span><span class="ot">NA</span></a>
<a class="sourceLine" id="cb16-3" data-line-number="3"><span class="kw">pandoc.table</span>(m, <span class="dt">missing =</span> <span class="st">'?'</span>)</a>
<a class="sourceLine" id="cb16-4" data-line-number="4"><span class="co">#> </span></a>
<a class="sourceLine" id="cb16-5" data-line-number="5"><span class="co">#> ---------------------------------------------------</span></a>
<a class="sourceLine" id="cb16-6" data-line-number="6"><span class="co">#> mpg cyl disp hp drat </span></a>
<a class="sourceLine" id="cb16-7" data-line-number="7"><span class="co">#> ------------------- ----- ----- ------ ----- ------</span></a>
<a class="sourceLine" id="cb16-8" data-line-number="8"><span class="co">#> Mazda RX4 ? 6 160 110 3.9 </span></a>
<a class="sourceLine" id="cb16-9" data-line-number="9"><span class="co">#> </span></a>
<a class="sourceLine" id="cb16-10" data-line-number="10"><span class="co">#> Mazda RX4 Wag ? 6 160 110 3.9 </span></a>
<a class="sourceLine" id="cb16-11" data-line-number="11"><span class="co">#> </span></a>
<a class="sourceLine" id="cb16-12" data-line-number="12"><span class="co">#> Datsun 710 ? 4 108 93 3.85 </span></a>
<a class="sourceLine" id="cb16-13" data-line-number="13"><span class="co">#> ---------------------------------------------------</span></a></code></pre></div>
</div>
<!-- dynamically load mathjax for compatibility with self-contained -->
<script>
(function () {
var script = document.createElement("script");
script.type = "text/javascript";
script.src = "https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML";
document.getElementsByTagName("head")[0].appendChild(script);
})();
</script>
</body>
</html>
|