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
To produce a LaTeX table, simply pass a matrix or a data.frame to the sTab function.
sTab(cars)
## \tablehead{\hline
## mpg & cyl & disp & hp & drat \\
## \hline}
## \tabletail{\hline}
## \begin{center}
## \begin{supertabular}{rrrrr}
## 21 & 6 & 160 & 110 & 3.9 \\
## 21 & 6 & 160 & 110 & 3.9 \\
## 22.8 & 4 & 108 & 93 & 3.85 \\
## 21.4 & 6 & 258 & 110 & 3.08 \\
## 18.7 & 8 & 360 & 175 & 3.15 \\
## 18.1 & 6 & 225 & 105 & 2.76 \\
## 14.3 & 8 & 360 & 245 & 3.21 \\
## 24.4 & 4 & 146.7 & 62 & 3.69 \\
## 22.8 & 4 & 140.8 & 95 & 3.92 \\
## 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}Pass a string into the ‘label’ option. When not set, defaults to NULL.
sTab(cars, label = 'tab:mytable')
## \tablehead{\hline
## mpg & cyl & disp & hp & drat \\
## \hline}
## \tabletail{\hline}
## \begin{center}
## \begin{supertabular}{rrrrr}
## \label{tab:mytable}
## 21 & 6 & 160 & 110 & 3.9 \\
## 21 & 6 & 160 & 110 & 3.9 \\
## 22.8 & 4 & 108 & 93 & 3.85 \\
## 21.4 & 6 & 258 & 110 & 3.08 \\
## 18.7 & 8 & 360 & 175 & 3.15 \\
## 18.1 & 6 & 225 & 105 & 2.76 \\
## 14.3 & 8 & 360 & 245 & 3.21 \\
## 24.4 & 4 & 146.7 & 62 & 3.69 \\
## 22.8 & 4 & 140.8 & 95 & 3.92 \\
## 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}Place a caption at the top of the table.
sTab(cars, caption.top = 'my table')
## \tablehead{\hline
## mpg & cyl & disp & hp & drat \\
## \hline}
## \tabletail{\hline}
## \topcaption{my table}
## \begin{center}
## \begin{supertabular}{rrrrr}
## 21 & 6 & 160 & 110 & 3.9 \\
## 21 & 6 & 160 & 110 & 3.9 \\
## 22.8 & 4 & 108 & 93 & 3.85 \\
## 21.4 & 6 & 258 & 110 & 3.08 \\
## 18.7 & 8 & 360 & 175 & 3.15 \\
## 18.1 & 6 & 225 & 105 & 2.76 \\
## 14.3 & 8 & 360 & 245 & 3.21 \\
## 24.4 & 4 & 146.7 & 62 & 3.69 \\
## 22.8 & 4 & 140.8 & 95 & 3.92 \\
## 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}Place a caption at the bottom of the table
sTab(cars, caption.bottom = 'my table')
## \tablehead{\hline
## mpg & cyl & disp & hp & drat \\
## \hline}
## \tabletail{\hline}
## \bottomcaption{my table}
## \begin{center}
## \begin{supertabular}{rrrrr}
## 21 & 6 & 160 & 110 & 3.9 \\
## 21 & 6 & 160 & 110 & 3.9 \\
## 22.8 & 4 & 108 & 93 & 3.85 \\
## 21.4 & 6 & 258 & 110 & 3.08 \\
## 18.7 & 8 & 360 & 175 & 3.15 \\
## 18.1 & 6 & 225 & 105 & 2.76 \\
## 14.3 & 8 & 360 & 245 & 3.21 \\
## 24.4 & 4 & 146.7 & 62 & 3.69 \\
## 22.8 & 4 & 140.8 & 95 & 3.92 \\
## 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}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.
sTab(cars, booktabs = TRUE)
## \tablehead{\toprule
## mpg & cyl & disp & hp & drat \\
## \midrule}
## \tabletail{\bottomrule}
## \begin{center}
## \begin{supertabular}{rrrrr}
## 21 & 6 & 160 & 110 & 3.9 \\
## 21 & 6 & 160 & 110 & 3.9 \\
## 22.8 & 4 & 108 & 93 & 3.85 \\
## 21.4 & 6 & 258 & 110 & 3.08 \\
## 18.7 & 8 & 360 & 175 & 3.15 \\
## 18.1 & 6 & 225 & 105 & 2.76 \\
## 14.3 & 8 & 360 & 245 & 3.21 \\
## 24.4 & 4 & 146.7 & 62 & 3.69 \\
## 22.8 & 4 & 140.8 & 95 & 3.92 \\
## 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}If any of those options are explicitly set, the booktabs value has no effect.
sTab(cars, booktabs = TRUE, midrule = '\\hline')
## \tablehead{\toprule
## mpg & cyl & disp & hp & drat \\
## \hline}
## \tabletail{\bottomrule}
## \begin{center}
## \begin{supertabular}{rrrrr}
## 21 & 6 & 160 & 110 & 3.9 \\
## 21 & 6 & 160 & 110 & 3.9 \\
## 22.8 & 4 & 108 & 93 & 3.85 \\
## 21.4 & 6 & 258 & 110 & 3.08 \\
## 18.7 & 8 & 360 & 175 & 3.15 \\
## 18.1 & 6 & 225 & 105 & 2.76 \\
## 14.3 & 8 & 360 & 245 & 3.21 \\
## 24.4 & 4 & 146.7 & 62 & 3.69 \\
## 22.8 & 4 & 140.8 & 95 & 3.92 \\
## 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}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
sTab(cars,
head = 'col1 & col 2 & col3 & \\eta & col5 \\\\')
## \tablehead{\hline
## col1 & col 2 & col3 & \eta & col5 \\
## \hline}
## \tabletail{\hline}
## \begin{center}
## \begin{supertabular}{rrrrr}
## 21 & 6 & 160 & 110 & 3.9 \\
## 21 & 6 & 160 & 110 & 3.9 \\
## 22.8 & 4 & 108 & 93 & 3.85 \\
## 21.4 & 6 & 258 & 110 & 3.08 \\
## 18.7 & 8 & 360 & 175 & 3.15 \\
## 18.1 & 6 & 225 & 105 & 2.76 \\
## 14.3 & 8 & 360 & 245 & 3.21 \\
## 24.4 & 4 & 146.7 & 62 & 3.69 \\
## 22.8 & 4 & 140.8 & 95 & 3.92 \\
## 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}Pass in NULL to avoid a table head. In the case of a NULL head, toprule and midrule will not be used.
sTab(cars, head = NULL)
## \tabletail{\hline}
## \begin{center}
## \begin{supertabular}{rrrrr}
## 21 & 6 & 160 & 110 & 3.9 \\
## 21 & 6 & 160 & 110 & 3.9 \\
## 22.8 & 4 & 108 & 93 & 3.85 \\
## 21.4 & 6 & 258 & 110 & 3.08 \\
## 18.7 & 8 & 360 & 175 & 3.15 \\
## 18.1 & 6 & 225 & 105 & 2.76 \\
## 14.3 & 8 & 360 & 245 & 3.21 \\
## 24.4 & 4 & 146.7 & 62 & 3.69 \\
## 22.8 & 4 & 140.8 & 95 & 3.92 \\
## 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}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.
sTab(cars, head = '', midrule = NULL)
## \tablehead{\hline
##
## }
## \tabletail{\hline}
## \begin{center}
## \begin{supertabular}{rrrrr}
## 21 & 6 & 160 & 110 & 3.9 \\
## 21 & 6 & 160 & 110 & 3.9 \\
## 22.8 & 4 & 108 & 93 & 3.85 \\
## 21.4 & 6 & 258 & 110 & 3.08 \\
## 18.7 & 8 & 360 & 175 & 3.15 \\
## 18.1 & 6 & 225 & 105 & 2.76 \\
## 14.3 & 8 & 360 & 245 & 3.21 \\
## 24.4 & 4 & 146.7 & 62 & 3.69 \\
## 22.8 & 4 & 140.8 & 95 & 3.92 \\
## 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}In a supertabular environment, it is possible to present a different first head (i.e. header on first page of table only).
sTab(cars,
firsthead = 'f1 & f2 & f3 & f4 & f5 \\\\')
## \tablefirsthead{\hline
## f1 & f2 & f3 & f4 & f5 \\
## \hline}
## \tablehead{\hline
## mpg & cyl & disp & hp & drat \\
## \hline}
## \tabletail{\hline}
## \begin{center}
## \begin{supertabular}{rrrrr}
## 21 & 6 & 160 & 110 & 3.9 \\
## 21 & 6 & 160 & 110 & 3.9 \\
## 22.8 & 4 & 108 & 93 & 3.85 \\
## 21.4 & 6 & 258 & 110 & 3.08 \\
## 18.7 & 8 & 360 & 175 & 3.15 \\
## 18.1 & 6 & 225 & 105 & 2.76 \\
## 14.3 & 8 & 360 & 245 & 3.21 \\
## 24.4 & 4 & 146.7 & 62 & 3.69 \\
## 22.8 & 4 & 140.8 & 95 & 3.92 \\
## 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}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.
sTab(cars, toprule = NULL, midrule = NULL,
firsthead = '\\toprule\nf1 & f2 & f3 & f4 & f5 \\\\\nmidrule',
head = '\\hline\n col1 & col2 & col3 & cll4 & col5 \\\\\n\\hline')
## \tablefirsthead{
## \toprule
## f1 & f2 & f3 & f4 & f5 \\
## midrule
## }
## \tablehead{
## \hline
## col1 & col2 & col3 & cll4 & col5 \\
## \hline
## }
## \tabletail{\hline}
## \begin{center}
## \begin{supertabular}{rrrrr}
## 21 & 6 & 160 & 110 & 3.9 \\
## 21 & 6 & 160 & 110 & 3.9 \\
## 22.8 & 4 & 108 & 93 & 3.85 \\
## 21.4 & 6 & 258 & 110 & 3.08 \\
## 18.7 & 8 & 360 & 175 & 3.15 \\
## 18.1 & 6 & 225 & 105 & 2.76 \\
## 14.3 & 8 & 360 & 245 & 3.21 \\
## 24.4 & 4 & 146.7 & 62 & 3.69 \\
## 22.8 & 4 & 140.8 & 95 & 3.92 \\
## 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}sTab(cars, toprule = NULL, midrule = NULL,
firsthead = '\\toprule\nf1 & f2 & f3 & f4 & f5 \\\\\nmidrule',
head = '\\toprule')
## \tablefirsthead{
## \toprule
## f1 & f2 & f3 & f4 & f5 \\
## midrule
## }
## \tablehead{
## \toprule
## }
## \tabletail{\hline}
## \begin{center}
## \begin{supertabular}{rrrrr}
## 21 & 6 & 160 & 110 & 3.9 \\
## 21 & 6 & 160 & 110 & 3.9 \\
## 22.8 & 4 & 108 & 93 & 3.85 \\
## 21.4 & 6 & 258 & 110 & 3.08 \\
## 18.7 & 8 & 360 & 175 & 3.15 \\
## 18.1 & 6 & 225 & 105 & 2.76 \\
## 14.3 & 8 & 360 & 245 & 3.21 \\
## 24.4 & 4 & 146.7 & 62 & 3.69 \\
## 22.8 & 4 & 140.8 & 95 & 3.92 \\
## 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}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.
sTab(cars, rows = TRUE)
## \tablehead{\hline
## & mpg & cyl & disp & hp & drat \\
## \hline}
## \tabletail{\hline}
## \begin{center}
## \begin{supertabular}{rrrrr}
## Mazda RX4 & 21.0 & 6 & 160.0 & 110 & 3.90 \\
## Mazda RX4 Wag & 21.0 & 6 & 160.0 & 110 & 3.90 \\
## Datsun 710 & 22.8 & 4 & 108.0 & 93 & 3.85 \\
## Hornet 4 Drive & 21.4 & 6 & 258.0 & 110 & 3.08 \\
## Hornet Sportabout & 18.7 & 8 & 360.0 & 175 & 3.15 \\
## Valiant & 18.1 & 6 & 225.0 & 105 & 2.76 \\
## Duster 360 & 14.3 & 8 & 360.0 & 245 & 3.21 \\
## Merc 240D & 24.4 & 4 & 146.7 & 62 & 3.69 \\
## Merc 230 & 22.8 & 4 & 140.8 & 95 & 3.92 \\
## Merc 280 & 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}When providing a custom head with rows set to TRUE, remember to account for the extra column produced by the row names
sTab(cars,
rows = TRUE,
head = 'rows & col1 & col2 & col3 & \\eta & col5 \\\\')
## \tablehead{\hline
## rows & col1 & col2 & col3 & \eta & col5 \\
## \hline}
## \tabletail{\hline}
## \begin{center}
## \begin{supertabular}{rrrrr}
## Mazda RX4 & 21.0 & 6 & 160.0 & 110 & 3.90 \\
## Mazda RX4 Wag & 21.0 & 6 & 160.0 & 110 & 3.90 \\
## Datsun 710 & 22.8 & 4 & 108.0 & 93 & 3.85 \\
## Hornet 4 Drive & 21.4 & 6 & 258.0 & 110 & 3.08 \\
## Hornet Sportabout & 18.7 & 8 & 360.0 & 175 & 3.15 \\
## Valiant & 18.1 & 6 & 225.0 & 105 & 2.76 \\
## Duster 360 & 14.3 & 8 & 360.0 & 245 & 3.21 \\
## Merc 240D & 24.4 & 4 & 146.7 & 62 & 3.69 \\
## Merc 230 & 22.8 & 4 & 140.8 & 95 & 3.92 \\
## Merc 280 & 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}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.
sTab(cars, rowsep = '\\hline')
## \tablehead{\hline
## mpg & cyl & disp & hp & drat \\
## \hline}
## \tabletail{\hline}
## \begin{center}
## \begin{supertabular}{rrrrr}
## 21 & 6 & 160 & 110 & 3.9 \\\hline
## 21 & 6 & 160 & 110 & 3.9 \\\hline
## 22.8 & 4 & 108 & 93 & 3.85 \\\hline
## 21.4 & 6 & 258 & 110 & 3.08 \\\hline
## 18.7 & 8 & 360 & 175 & 3.15 \\\hline
## 18.1 & 6 & 225 & 105 & 2.76 \\\hline
## 14.3 & 8 & 360 & 245 & 3.21 \\\hline
## 24.4 & 4 & 146.7 & 62 & 3.69 \\\hline
## 22.8 & 4 & 140.8 & 95 & 3.92 \\\hline
## 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}sTab(cars, rowsep = '\\midrule')
## \tablehead{\hline
## mpg & cyl & disp & hp & drat \\
## \hline}
## \tabletail{\hline}
## \begin{center}
## \begin{supertabular}{rrrrr}
## 21 & 6 & 160 & 110 & 3.9 \\\midrule
## 21 & 6 & 160 & 110 & 3.9 \\\midrule
## 22.8 & 4 & 108 & 93 & 3.85 \\\midrule
## 21.4 & 6 & 258 & 110 & 3.08 \\\midrule
## 18.7 & 8 & 360 & 175 & 3.15 \\\midrule
## 18.1 & 6 & 225 & 105 & 2.76 \\\midrule
## 14.3 & 8 & 360 & 245 & 3.21 \\\midrule
## 24.4 & 4 & 146.7 & 62 & 3.69 \\\midrule
## 22.8 & 4 & 140.8 & 95 & 3.92 \\\midrule
## 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}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.
sTab(cars, coldef ='rlc|l|p{5cm}')
## \tablehead{\hline
## mpg & cyl & disp & hp & drat \\
## \hline}
## \tabletail{\hline}
## \begin{center}
## \begin{supertabular}{rlc|l|p{5cm}}
## 21 & 6 & 160 & 110 & 3.9 \\
## 21 & 6 & 160 & 110 & 3.9 \\
## 22.8 & 4 & 108 & 93 & 3.85 \\
## 21.4 & 6 & 258 & 110 & 3.08 \\
## 18.7 & 8 & 360 & 175 & 3.15 \\
## 18.1 & 6 & 225 & 105 & 2.76 \\
## 14.3 & 8 & 360 & 245 & 3.21 \\
## 24.4 & 4 & 146.7 & 62 & 3.69 \\
## 22.8 & 4 & 140.8 & 95 & 3.92 \\
## 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}Place any arbitrary LaTeX between each column. Will have no effect if coldef is set.
sTab(cars, colsep = '|')
## \tablehead{\hline
## mpg & cyl & disp & hp & drat \\
## \hline}
## \tabletail{\hline}
## \begin{center}
## \begin{supertabular}{r|r|r|r|r}
## 21 & 6 & 160 & 110 & 3.9 \\
## 21 & 6 & 160 & 110 & 3.9 \\
## 22.8 & 4 & 108 & 93 & 3.85 \\
## 21.4 & 6 & 258 & 110 & 3.08 \\
## 18.7 & 8 & 360 & 175 & 3.15 \\
## 18.1 & 6 & 225 & 105 & 2.76 \\
## 14.3 & 8 & 360 & 245 & 3.21 \\
## 24.4 & 4 & 146.7 & 62 & 3.69 \\
## 22.8 & 4 & 140.8 & 95 & 3.92 \\
## 19.2 & 6 & 167.6 & 123 & 3.92 \\
## \end{supertabular}
## \end{center}