---
title: "sTab"
author: "John Shea"
date: "`r Sys.Date()`"
output:
  rmarkdown::html_vignette:
    toc: true
vignette: >
  %\VignetteIndexEntry{sTab}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

```{r, echo = FALSE}
library(knitLatex)
knitr::opts_chunk$set(collapse = TRUE)
cars  <- mtcars[1:10,1:5]
```

# Introduction

sTab is a function that produces a supertabular environment.

For all of the examples that follow, we will be using the first ten rows and
five columns of the mtcars data.frame, which we have saved in the variable
'cars'. In an actual use case, a table this small could easily be accommodated
with xTab, however, for the purposes of these demonstrations, it will be easier
to see the effects of the individual options without needing to comb through a
large, multi-page table. 

**Important Notes**

* When passing LaTeX commands to an sTab argument, backslashes must be escaped.
  For example, you need to pass '\\\\hline' to produce '\\hline' in the LaTeX
  document. Similarly you must pass'\\\\\\\\' to produce '\\\\'.
* The following examples write the LaTeX tables to stdout for demonstration
  purposes. To see an actual .Rnw file, and the resultant pdf file, select the
  links below. The pdf file is written to be a knitLatex tutorial in and of
  itself. However, reading the .Rnw file can provide further insight into the
  uses of this package.
    + [example.Rnw](../examples/example.Rnw)
    + [example.pdf](../examples/example.pdf)

# Basics

## Standard sTab table

To produce a LaTeX table, simply pass a matrix or a data.frame to the sTab
function.

```{r}
sTab(cars)
```

## Labels

Pass a string into the 'label' option. When not set, defaults to NULL.

```{r}
sTab(cars, label = 'tab:mytable')
```

## Captions

Place a caption at the top of the table.

```{r}
sTab(cars, caption.top = 'my table')
```

Place a caption at the bottom of the table

```{r}
sTab(cars, caption.bottom = 'my table')
```

## Booktabs

Setting booktabs = TRUE sets the defaults of the toprule, midrule, and
bottomrule arguments to \\toprule, \\midrule, and \\bottomrule respectively.
When using booktabs rules, regardless of whether you set booktabs = TRUE or set
them individually, make sure to include \\usepackage{booktabs} in your LaTeX
document. When booktabs is not set, sTab looks for the value of
kLat.sTab.booktabs, then kLat.booktabs, then defaults to FALSE.

```{r}
sTab(cars, booktabs = TRUE)
```

If any of those options are explicitly set, the booktabs value has no effect. 

```{r}
sTab(cars, booktabs = TRUE, midrule = '\\hline')
```

# Headers

## Head

By default, sTab will use the column names for the head of the table(as
demonstrated in the above examples). The head argument is diplayed at the top of
the table on each page that the table spans. To customize the table head simply
pass in the appropriate LaTeX to the 'head' argument. The values of toprule and
midrule are still used and should not be set in the head argument. If you do not
want them included in your custom header, set either or both to NULL

```{r}
sTab(cars,
     head = 'col1 & col 2 & col3 & \\eta & col5 \\\\')
```

Pass in NULL to avoid a table head. In the case of a NULL head, toprule and
midrule will not be used.

```{r}
sTab(cars, head = NULL)
```

To preserve the top and midrules, pass an empty string to head. Often, people
want a toprule with no head or midrule. In that case, pass an empty string into
the head argument and NULL into midule. You can then use the default toprule
value (as depicted below), explicitly set toprule, or set booktabs = TRUE to set
the toprule and bottomrule simultaneously.

```{r}
sTab(cars, head = '', midrule = NULL)
```

## FirstHead

In a supertabular environment, it is possible to present a different first head
(i.e. header on first page of table only).

```{r}
sTab(cars,
     firsthead = 'f1 & f2 & f3 & f4 & f5 \\\\')
```

**Important Note**

As demonstrated in the above example, both head and firsthead use the toprule
and midrule commands by default. If you desire to use different commands for the
head and firsthead (or if you want one, but not both to use a top and
midrule), you must set both toprule and midrule to NULL and manually insert the
commands into head and firsthead as shown below examples.

```{r}
sTab(cars, toprule = NULL, midrule = NULL,
     firsthead = '\\toprule\nf1 & f2 & f3 & f4 & f5 \\\\\nmidrule',
     head = '\\hline\n col1 & col2 & col3 & cll4 & col5 \\\\\n\\hline')
```

```{r}
sTab(cars, toprule = NULL, midrule = NULL,
     firsthead = '\\toprule\nf1 & f2 & f3 & f4 & f5 \\\\\nmidrule',
     head = '\\toprule')
```

# Rows

## Rownames

When including row names in a table, by default sTab will use an empty column
name for the 'rownames' column. When rows is not set, sTab looks for the value
of kLat.sTab.rows, then klat.rows, then defaults to false.

```{r}
sTab(cars, rows = TRUE)
```

## Rownames with custom header

When providing a custom head with rows set to TRUE, remember to account for the
extra column produced by the row names

```{r}
sTab(cars,
     rows =  TRUE,
     head = 'rows & col1 & col2 & col3 & \\eta & col5 \\\\')
```

## Row separator

Any arbitrary LaTeX command can be inserted between each row, but the most
common are \\hline and \\midrule. To use \\midrule, \\usepackage{booktabs} must
be declared in the preamble of the LaTeX document, but booktabs = TRUE **does
not** need to be set on the table. When rowsep is not set, sTab looks for the
value of kLat.sTab.rowsep, then kLat.rowsep, then defaults to an empty string.

```{r}
sTab(cars, rowsep = '\\hline')
```

```{r}
sTab(cars, rowsep = '\\midrule')
```

# Columns

## Column alginment

Explicitly set the column definitions. If this is set, colsep will have no effect
and you must handle column separation within this declaration. Defaults to 'r' for
numeric vector columns and 'l' for character vector columns.

```{r}
sTab(cars, coldef ='rlc|l|p{5cm}')
```

## Column separator

Place any arbitrary LaTeX between each column. Will have no effect if coldef is
set.

```{r}
sTab(cars, colsep = '|')
```
