A General-Purpose Package for Dynamic Report Generation in R


[Up] [Top]

Documentation for package ‘knitr’ version 1.15.13

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 --

clean_cache Clean cache files that are probably no longer needed
combine_words Combine multiple words into a single string
current_input Query the current input filename

-- D --

dep_auto Build automatic dependencies among chunks
dep_prev Make later chunks depend on previous chunks

-- 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 --

hook_ffmpeg_html Hooks to create animations in HTML output
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

-- K --

kable Create tables in LaTeX, HTML, Markdown and reStructuredText
knit Knit a document
knit2html Convert markdown to HTML using knit() and markdownToHTML()
knit2pdf Convert Rnw or Rrst files to PDF using knit() and texi2pdf() or rst2pdf()
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_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
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_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 output hooks for different output formats
render_html Set output hooks for different output formats
render_jekyll Set output hooks for different output formats
render_latex Set output hooks for different output formats
render_listings Set output hooks for different output formats
render_markdown Set output hooks for different output formats
render_rst Set output hooks for different output formats
render_sweave Set output hooks for different output formats
render_textile Set output hooks for different output formats
restore_raw_output Mark character strings as raw output that should not be converted
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
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