Hao Zhu | e10cfd3 | 2017-02-21 16:41:14 -0500 | [diff] [blame] | 1 | % Generated by roxygen2: do not edit by hand |
Hao Zhu | c1f3841 | 2017-02-23 12:13:48 -0500 | [diff] [blame] | 2 | % Please edit documentation in R/kable_styling.R |
| 3 | \name{kable_styling} |
| 4 | \alias{kable_styling} |
Hao Zhu | e10cfd3 | 2017-02-21 16:41:14 -0500 | [diff] [blame] | 5 | \title{HTML table attributes} |
| 6 | \usage{ |
Hao Zhu | a3fc0c4 | 2017-02-27 12:04:59 -0500 | [diff] [blame] | 7 | kable_styling(kable_input, bootstrap_options = "basic", |
| 8 | latex_options = "basic", full_width = NULL, position = c("center", |
| 9 | "left", "right", "float_left", "float_right"), font_size = NULL) |
Hao Zhu | e10cfd3 | 2017-02-21 16:41:14 -0500 | [diff] [blame] | 10 | } |
| 11 | \arguments{ |
Hao Zhu | f7994dd | 2017-02-27 16:58:42 -0500 | [diff] [blame^] | 12 | \item{kable_input}{Output of `knitr::kable()` with `format` specified} |
| 13 | |
| 14 | \item{bootstrap_options}{A character vector for bootstrap table options. |
| 15 | Please see package documentation site or visit the w3schools' |
| 16 | \href{https://www.w3schools.com/bootstrap/bootstrap_tables.asp}{Bootstrap Page} |
| 17 | for more information. Possible options include `basic`, `striped`, |
| 18 | `bordered`, `hover`, `condensed` and `responsive`.} |
| 19 | |
| 20 | \item{latex_options}{A character vector for LaTeX table options. Please see |
| 21 | package documentation site for more information. Possible options include |
| 22 | `basic`, `striped`, `hold_position`, `scale_down`. `striped` will add |
| 23 | alternative row colors to the table. It will imports `LaTeX` package `xcolor` |
| 24 | if enabled. `hold_position` will "hold" the floating table to the exact |
| 25 | position. It is useful when the `LaTeX` table is contained in a `table` |
| 26 | environment after you specified captions in `kable()`. It will force the |
| 27 | table to stay in the position where it was created in the document. |
| 28 | `scale_down` is useful for super wide table. It will automatically adjust |
| 29 | the table to page width.} |
Hao Zhu | e10cfd3 | 2017-02-21 16:41:14 -0500 | [diff] [blame] | 30 | |
Hao Zhu | 2623412 | 2017-02-22 15:34:33 -0500 | [diff] [blame] | 31 | \item{full_width}{A `TRUE` or `FALSE` variable controlling whether the HTML |
Hao Zhu | f7994dd | 2017-02-27 16:58:42 -0500 | [diff] [blame^] | 32 | table should have 100\% width. Since HTML and pdf have different flavors on |
| 33 | the preferable format for `full_width`. If not specified, a HTML table will |
| 34 | have full width by default but this option will be set to `FALSE` for a |
| 35 | LaTeX table} |
Hao Zhu | 9495658 | 2017-02-21 18:18:29 -0500 | [diff] [blame] | 36 | |
Hao Zhu | f7994dd | 2017-02-27 16:58:42 -0500 | [diff] [blame^] | 37 | \item{position}{A character string determining how to position the table |
| 38 | on a page. Possible values include `left`, `center`, `right`, `float_left` |
| 39 | and `float_right`. Please see the package doc site for demonstrations. For |
| 40 | a `LaTeX` table, if `float_*` is selected, `LaTeX` package `wrapfig` will be |
| 41 | imported.} |
Hao Zhu | 9495658 | 2017-02-21 18:18:29 -0500 | [diff] [blame] | 42 | |
| 43 | \item{font_size}{A numeric input for table font size} |
Hao Zhu | e10cfd3 | 2017-02-21 16:41:14 -0500 | [diff] [blame] | 44 | } |
| 45 | \description{ |
Hao Zhu | 2623412 | 2017-02-22 15:34:33 -0500 | [diff] [blame] | 46 | This function provides a cleaner approach to modify the style |
| 47 | of HTML tables other than using the `table.attr` option in `knitr::kable()`. |
| 48 | Currenly, it assumes the HTML document has boot |
Hao Zhu | e10cfd3 | 2017-02-21 16:41:14 -0500 | [diff] [blame] | 49 | } |