Hao Zhu | 2a64dc6 | 2017-08-28 10:57:57 -0400 | [diff] [blame] | 1 | % Generated by roxygen2: do not edit by hand |
| 2 | % Please edit documentation in R/kable_as_image.R |
| 3 | \name{kable_as_image} |
| 4 | \alias{kable_as_image} |
Hao Zhu | 8902df8 | 2019-01-07 16:27:32 -0500 | [diff] [blame] | 5 | \title{Deprecated} |
Hao Zhu | 2a64dc6 | 2017-08-28 10:57:57 -0400 | [diff] [blame] | 6 | \usage{ |
| 7 | kable_as_image(kable_input, filename = NULL, file_format = "png", |
Hao Zhu | 68b5bbf | 2018-03-26 11:30:34 -0400 | [diff] [blame] | 8 | latex_header_includes = NULL, keep_pdf = FALSE, density = 300, |
| 9 | keep_tex = FALSE) |
Hao Zhu | 2a64dc6 | 2017-08-28 10:57:57 -0400 | [diff] [blame] | 10 | } |
| 11 | \arguments{ |
| 12 | \item{kable_input}{Raw LaTeX code to generate a table. It doesn't have to |
| 13 | came from \code{kable} or \code{kableExtra}.} |
| 14 | |
| 15 | \item{filename}{Character String. If specified, the image will be saved under |
| 16 | the specified (path &) name. You don't need to put file format like ".png" |
| 17 | here.} |
| 18 | |
| 19 | \item{file_format}{Character String to specify image format, such as \code{png}, |
| 20 | \code{jpeg}, \code{gif}, \code{tiff}, etc. Default is \code{png}.} |
| 21 | |
| 22 | \item{latex_header_includes}{A character vector of extra LaTeX header stuff. |
| 23 | Each element is a row. You can have things like |
antaldaniel | bfaf703 | 2018-05-30 21:55:18 +0200 | [diff] [blame] | 24 | \code{c("\\\\usepackage{threeparttable}", "\\\\usepackage{icons}")} You could |
| 25 | probably add your language package here if you use non-English text in your |
| 26 | table, such as \code{\\\\usepackage[magyar]{babel}}.} |
Hao Zhu | 2a64dc6 | 2017-08-28 10:57:57 -0400 | [diff] [blame] | 27 | |
| 28 | \item{keep_pdf}{A T/F option to control if the mid-way standalone pdf should |
| 29 | be kept. Default is \code{FALSE}.} |
Hao Zhu | 4840bc9 | 2017-09-15 15:55:05 -0400 | [diff] [blame] | 30 | |
| 31 | \item{density}{Resolution to read the PDF file. Default value is 300, which |
| 32 | should be sufficient in most cases.} |
Hao Zhu | 68b5bbf | 2018-03-26 11:30:34 -0400 | [diff] [blame] | 33 | |
| 34 | \item{keep_tex}{A T/F option to control if the latex file that is initially created |
| 35 | should be kept. Default is \code{FALSE}.} |
Hao Zhu | 2a64dc6 | 2017-08-28 10:57:57 -0400 | [diff] [blame] | 36 | } |
| 37 | \description{ |
Hao Zhu | 8902df8 | 2019-01-07 16:27:32 -0500 | [diff] [blame] | 38 | deprecated |
Hao Zhu | 2a64dc6 | 2017-08-28 10:57:57 -0400 | [diff] [blame] | 39 | } |
Jiaxiang Li | fcb8d45 | 2019-04-05 12:05:10 +0800 | [diff] [blame] | 40 | \examples{ |
| 41 | \dontrun{ |
| 42 | library(kableExtra) |
| 43 | |
| 44 | kable(mtcars[1:5, ], "html") \%>\% |
| 45 | kable_styling("striped") \%>\% |
| 46 | row_spec(1, color = "red") \%>\% |
| 47 | save_kable("inst/test.pdf") |
| 48 | |
| 49 | kable(mtcars, "latex", booktabs = T) \%>\% |
| 50 | kable_styling(latex_options = c("striped", "scale_down")) \%>\% |
| 51 | row_spec(1, color = "red") \%>\% |
| 52 | as_image() |
| 53 | } |
| 54 | } |