A General-Purpose Package for Dynamic Report Generation in R
![[R logo]](../../../doc/html/Rlogo.svg)
![[Up]](../../../doc/html/left.jpg)
![[Top]](../../../doc/html/up.jpg)
Documentation for package ‘knitr’ version 1.45
- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Code demos. Use demo() to run them.
- Package NEWS.
Help Pages
A C D E F H I K L N O P R S V W
| knitr-package | A general-purpose tool for dynamic report generation in R |
-- A --
| all_labels | Get all chunk labels in a document |
| all_patterns | All built-in patterns |
| all_rcpp_labels | Get all chunk labels in a document |
| asis_output | Mark an R object with a special class |
-- C --
| cache_engines | Cache engines of other languages |
| clean_cache | Clean cache files that are probably no longer needed |
| combine_words | Combine multiple words into a single string |
| convert_chunk_header | Convert the in-header chunk option syntax to the in-body syntax |
| current_input | Query the current input filename |
-- D --
| dep_auto | Build automatic dependencies among chunks |
| dep_prev | Make later chunks depend on previous chunks |
| download_image | Download an image from the web and include it in a document |
-- E --
| engine_output | An output wrapper for language engine output |
| extract_raw_output | Mark character strings as raw output that should not be converted |
-- F --
| fig_chunk | Obtain the figure filenames for a chunk |
| fig_path | Path for figure files |
-- H --
| hooks_asciidoc | Set or get output hooks for different output formats |
| hooks_html | Set or get output hooks for different output formats |
| hooks_jekyll | Set or get output hooks for different output formats |
| hooks_latex | Set or get output hooks for different output formats |
| hooks_listings | Set or get output hooks for different output formats |
| hooks_markdown | Set or get output hooks for different output formats |
| hooks_rst | Set or get output hooks for different output formats |
| hooks_sweave | Set or get output hooks for different output formats |
| hooks_textile | Set or get output hooks for different output formats |
| hook_ffmpeg_html | Hooks to create animations in HTML output |
| hook_gifski | Hooks to create animations in HTML output |
| hook_mogrify | Built-in chunk hooks to extend knitr |
| hook_movecode | Some potentially useful document hooks |
| hook_optipng | Built-in chunk hooks to extend knitr |
| hook_pdfcrop | Built-in chunk hooks to extend knitr |
| hook_plot_asciidoc | Default plot hooks for different output formats |
| hook_plot_custom | Built-in chunk hooks to extend knitr |
| hook_plot_html | Default plot hooks for different output formats |
| hook_plot_md | Default plot hooks for different output formats |
| hook_plot_rst | Default plot hooks for different output formats |
| hook_plot_tex | Default plot hooks for different output formats |
| hook_plot_textile | Default plot hooks for different output formats |
| hook_pngquant | Built-in chunk hooks to extend knitr |
| hook_purl | Built-in chunk hooks to extend knitr |
| hook_r2swf | Hooks to create animations in HTML output |
| hook_scianimator | Hooks to create animations in HTML output |
-- I --
| image_uri | Encode an image file to a data URI |
| imgur_upload | Upload an image to imgur.com |
| include_app | Embed a URL as an HTML iframe or a screenshot in 'knitr' documents |
| include_graphics | Embed external images in 'knitr' documents |
| include_url | Embed a URL as an HTML iframe or a screenshot in 'knitr' documents |
| inline_expr | Wrap code using the inline R expression syntax |
| is_html_output | Check the current input and output type |
| is_latex_output | Check the current input and output type |
| is_low_change | Compare two recorded plots |
-- K --
| kable | Create tables in LaTeX, HTML, Markdown and reStructuredText |
| kables | Create tables in LaTeX, HTML, Markdown and reStructuredText |
| knit | Knit a document |
| knit2html | Convert markdown to HTML using knit() and mark_html() |
| knit2pandoc | Convert various input files to various output files using 'knit()' and Pandoc |
| knit2pdf | Convert Rnw or Rrst files to PDF |
| knit2wp | Knit an R Markdown document and post it to WordPress |
| knitr | A general-purpose tool for dynamic report generation in R |
| knit_child | Knit a child document |
| knit_code | The code manager to manage code in all chunks |
| knit_engines | Engines of other languages |
| knit_exit | Exit knitting early |
| knit_expand | A simple macro preprocessor for templating purposes |
| knit_filter | Spell check filter for source documents |
| knit_global | The global environment in which code chunks are evaluated |
| knit_hooks | Hooks for R code chunks, inline R code and output |
| knit_meta | Metadata about objects to be printed |
| knit_meta_add | Metadata about objects to be printed |
| knit_params | Extract knit parameters from a document |
| knit_params_yaml | Extract knit parameters from YAML text |
| knit_patterns | Patterns to match and extract R code in a document |
| knit_print | A custom printing function |
| knit_rd | Knit package documentation |
| knit_rd_all | Knit package documentation |
| knit_theme | Syntax highlighting themes |
| knit_watch | Watch an input file continuously and knit it when it is updated |
-- L --
| load_cache | Load the cache database of a code chunk |
-- N --
| normal_print | A custom printing function |
-- O --
| opts_chunk | Default and current chunk options |
| opts_current | Default and current chunk options |
| opts_hooks | Hooks for code chunk options |
| opts_knit | Options for the knitr package |
| opts_template | Template for creating reusable chunk options |
-- P --
| pandoc | A Pandoc wrapper to convert documents to other formats |
| pandoc_from | Check the current input and output type |
| pandoc_to | Check the current input and output type |
| partition_chunk | Partition chunk options from the code chunk body |
| pat_asciidoc | Set regular expressions to read input documents |
| pat_brew | Set regular expressions to read input documents |
| pat_html | Set regular expressions to read input documents |
| pat_md | Set regular expressions to read input documents |
| pat_rnw | Set regular expressions to read input documents |
| pat_rst | Set regular expressions to read input documents |
| pat_tex | Set regular expressions to read input documents |
| pat_textile | Set regular expressions to read input documents |
| plot_crop | Crop a plot (remove the edges) using PDFCrop or ImageMagick |
| purl | Knit a document |
-- R --
| rand_seed | An unevaluated expression to return .Random.seed if exists |
| raw_block | Mark character strings as raw blocks in R Markdown |
| raw_html | Mark character strings as raw blocks in R Markdown |
| raw_latex | Mark character strings as raw blocks in R Markdown |
| raw_output | Mark character strings as raw output that should not be converted |
| read_chunk | Read chunks from an external script |
| read_demo | Read chunks from an external script |
| read_rforge | Read source code from R-Forge |
| render_asciidoc | Set or get output hooks for different output formats |
| render_html | Set or get output hooks for different output formats |
| render_jekyll | Set or get output hooks for different output formats |
| render_latex | Set or get output hooks for different output formats |
| render_listings | Set or get output hooks for different output formats |
| render_markdown | Set or get output hooks for different output formats |
| render_rst | Set or get output hooks for different output formats |
| render_sweave | Set or get output hooks for different output formats |
| render_textile | Set or get output hooks for different output formats |
| restore_raw_output | Mark character strings as raw output that should not be converted |
| rnw2pdf | Convert an 'Rnw' document to PDF |
| rocco | Knit R Markdown using the classic Docco style |
| rst2pdf | A wrapper for rst2pdf |
-- S --
| set_alias | Set aliases for chunk options |
| set_header | Set the header information |
| set_parent | Specify the parent document of child documents |
| sew | Wrap evaluated results for output |
| spin | Spin goat's hair into wool |
| spin_child | Spin a child R script |
| stitch | Automatically create a report based on an R script and a template |
| stitch_rhtml | Automatically create a report based on an R script and a template |
| stitch_rmd | Automatically create a report based on an R script and a template |
| Sweave2knitr | Convert Sweave to knitr documents |
-- V --
| vignette_engines | Package vignette engines |
-- W --
| wrap_rmd | Wrap long lines in Rmd files |
| write_bib | Generate BibTeX bibliography databases for R packages |