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 | 9495658 | 2017-02-21 18:18:29 -0500 | [diff] [blame] | 12 | \item{bootstrap_options}{A character vector for bootstrap table options. For |
| 13 | detailed information, please check the package vignette or visit the |
Hao Zhu | 59f5fe0 | 2017-02-22 11:27:14 -0500 | [diff] [blame] | 14 | w3schools' \href{https://www.w3schools.com/bootstrap/bootstrap_tables.asp}{Bootstrap Page} |
Hao Zhu | 2623412 | 2017-02-22 15:34:33 -0500 | [diff] [blame] | 15 | . Possible options include "basic", "striped", "bordered", "hover", |
Hao Zhu | 9495658 | 2017-02-21 18:18:29 -0500 | [diff] [blame] | 16 | "condensed" and "responsive".} |
Hao Zhu | e10cfd3 | 2017-02-21 16:41:14 -0500 | [diff] [blame] | 17 | |
Hao Zhu | 2623412 | 2017-02-22 15:34:33 -0500 | [diff] [blame] | 18 | \item{full_width}{A `TRUE` or `FALSE` variable controlling whether the HTML |
Hao Zhu | 9495658 | 2017-02-21 18:18:29 -0500 | [diff] [blame] | 19 | table should have 100\% width.} |
| 20 | |
Hao Zhu | a3fc0c4 | 2017-02-27 12:04:59 -0500 | [diff] [blame^] | 21 | \item{position}{A character string determining whether and how the HTML table |
Hao Zhu | 2623412 | 2017-02-22 15:34:33 -0500 | [diff] [blame] | 22 | should float on the page. Values could be "left", "center", "right"} |
Hao Zhu | 9495658 | 2017-02-21 18:18:29 -0500 | [diff] [blame] | 23 | |
| 24 | \item{font_size}{A numeric input for table font size} |
Hao Zhu | e10cfd3 | 2017-02-21 16:41:14 -0500 | [diff] [blame] | 25 | } |
| 26 | \description{ |
Hao Zhu | 2623412 | 2017-02-22 15:34:33 -0500 | [diff] [blame] | 27 | This function provides a cleaner approach to modify the style |
| 28 | of HTML tables other than using the `table.attr` option in `knitr::kable()`. |
| 29 | Currenly, it assumes the HTML document has boot |
Hao Zhu | e10cfd3 | 2017-02-21 16:41:14 -0500 | [diff] [blame] | 30 | } |