knitr: A General-Purpose Package for Dynamic Report Generation in R

Provides a general-purpose tool for dynamic report generation in R using Literate Programming techniques.

Install the latest version of this package by entering the following in R:
install.packages("knitr")
AuthorYihui Xie [aut, cre], Adam Vogt [ctb], Alastair Andrew [ctb], Alex Zvoleff [ctb], Andre Simon [ctb] (the CSS files under inst/themes/ were derived from the Highlight package http://www.andre-simon.de), Aron Atkins [ctb], Aaron Wolen [ctb], Ashley Manton [ctb], Ben Baumer [ctb], Brian Diggs [ctb], Cassio Pereira [ctb], David Robinson [ctb], Donald Arseneau [ctb, cph] (the framed package at inst/misc/framed.sty), Doug Hemken [ctb], Duncan Murdoch [ctb], Fabian Hirschmann [ctb], Fitch Simeon [ctb], Frank E Harrell Jr [ctb] (the Sweavel package at inst/misc/Sweavel.sty), Gregoire Detrez [ctb], Hadley Wickham [ctb], Heewon Jeon [ctb], Henrik Bengtsson [ctb], Hiroaki Yutani [ctb], Jake Burkhead [ctb], James Manton [ctb], Jared Lander [ctb], Jason Punyon [ctb], Jeff Arnold [ctb], Jeremy Ashkenas [ctb, cph] (the CSS file at inst/misc/docco-classic.css), Jeremy Stephens [ctb], Jim Hester [ctb], Joe Cheng [ctb], Johannes Ranke [ctb], John Honaker [ctb], John Muschelli [ctb], Jonathan Keane [ctb], JJ Allaire [ctb], Johan Toloe [ctb], Joseph Larmarange [ctb], Julien Barnier [ctb], Kaiyin Zhong [ctb], Kamil Slowikowski [ctb], Kevin K. Smith [ctb], Kirill Mueller [ctb], Kohske Takahashi [ctb], Michael Friendly [ctb], Michal Bojanowski [ctb], Michel Kuhlmann [ctb], Nacho Caballero [ctb], Nick Salkowski [ctb], Noam Ross [ctb], Qiang Li [ctb], Ramnath Vaidyanathan [ctb], Richard Cotton [ctb], Robert Krzyzanowski [ctb], Romain Francois [ctb], Scott Kostyshak [ctb], Sebastian Meyer [ctb], Sietse Brouwer [ctb], Simon de Bernard [ctb], Taiyun Wei [ctb], Thibaut Assus [ctb], Thibaut Lamadon [ctb], Thomas Leeper [ctb], Tom Torsney-Weir [ctb], Trevor Davis [ctb], Viktoras Veitas [ctb], Weicheng Zhu [ctb], Wush Wu [ctb], Zachary Foster [ctb]
Date of publication2016-11-22 09:36:46
MaintainerYihui Xie <xie@yihui.name>
LicenseGPL
Version1.15.1
http://yihui.name/knitr/

View on CRAN

Man pages

all_labels: Get all chunk labels in a document

all_patterns: All built-in patterns

asis_output: Mark an R object with a special class

chunk_hook: Built-in chunk hooks to extend knitr

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

dep_auto: Build automatic dependencies among chunks

dep_prev: Make later chunks depend on previous chunks

engine_output: An output wrapper for language engine output

fig_chunk: Obtain the figure filenames for a chunk

fig_path: Path for figure files

hook_animation: Hooks to create animations in HTML output

hook_document: Some potentially useful document hooks

hook_plot: Default plot hooks for different output formats

image_uri: Encode an image file to a data URI

imgur_upload: Upload an image to imgur.com

include_graphics: Embed external images in 'knitr' documents

include_url: Embed a URL as an HTML iframe or a screenshot in 'knitr'...

inline_expr: Wrap code using the inline R expression syntax

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()...

knit2wp: Knit an R Markdown document and post it to WordPress

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

knitr-package: A general-purpose tool for dynamic report generation in R

knit_theme: Syntax highlighting themes

knit_watch: Watch an input file continuously and knit it when it is...

load_cache: Load the cache database of a code chunk

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

output_hooks: Set output hooks for different output formats

pandoc: A Pandoc wrapper to convert documents to other formats

pat_fun: Set regular expressions to read input documents

plot_crop: Crop a plot (remove the edges) using PDFCrop or ImageMagick

rand_seed: An unevaluated expression to return .Random.seed if exists

raw_output: Mark character strings as raw output that should not be...

read_chunk: Read chunks from an external script

read_rforge: Read source code from R-Forge

rocco: Knit R Markdown using the classic Docco style

rst2pdf: A wrapper for rst2pdf

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

Sweave2knitr: Convert Sweave to knitr documents

vignette_engines: Package vignette engines

wrap_rmd: Wrap long lines in Rmd files

write_bib: Generate BibTeX bibliography databases for R packages

Functions

all_labels Man page
all_patterns Man page
all_rcpp_labels Man page
asis_output Man page
clean_cache Man page
combine_words Man page
current_input Man page
dep_auto Man page
dep_prev Man page
engine_output Man page
extract_raw_output Man page
fig_chunk Man page
fig_path Man page
hook_ffmpeg_html Man page
hook_movecode Man page
hook_optipng Man page
hook_pdfcrop Man page
hook_plot_asciidoc Man page
hook_plot_custom Man page
hook_plot_html Man page
hook_plot_md Man page
hook_plot_rst Man page
hook_plot_tex Man page
hook_plot_textile Man page
hook_pngquant Man page
hook_purl Man page
hook_r2swf Man page
hook_scianimator Man page
image_uri Man page
imgur_upload Man page
include_app Man page
include_graphics Man page
include_url Man page
inline_expr Man page
kable Man page
knit Man page
knit2html Man page
knit2pdf Man page
knit2wp Man page
knit_child Man page
knit_engines Man page
knit_exit Man page
knit_expand Man page
knit_filter Man page
knit_global Man page
knit_hooks Man page
knit_meta Man page
knit_meta_add Man page
knit_params Man page
knit_params_yaml Man page
knit_patterns Man page
knit_print Man page
knitr Man page
knit_rd Man page
knit_rd_all Man page
knitr-package Man page
knit_theme Man page
knit_watch Man page
load_cache Man page
normal_print Man page
opts_chunk Man page
opts_current Man page
opts_hooks Man page
opts_knit Man page
opts_template Man page
pandoc Man page
pat_asciidoc Man page
pat_brew Man page
pat_html Man page
pat_md Man page
pat_rnw Man page
pat_rst Man page
pat_tex Man page
pat_textile Man page
plot_crop Man page
purl Man page
rand_seed Man page
raw_output Man page
read_chunk Man page
read_demo Man page
read_rforge Man page
render_asciidoc Man page
render_html Man page
render_jekyll Man page
render_latex Man page
render_listings Man page
render_markdown Man page
render_rst Man page
render_sweave Man page
render_textile Man page
restore_raw_output Man page
rocco Man page
rst2pdf Man page
set_alias Man page
set_header Man page
set_parent Man page
spin Man page
spin_child Man page
stitch Man page
stitch_rhtml Man page
stitch_rmd Man page
Sweave2knitr Man page
vignette_engines Man page
wrap_rmd Man page
write_bib Man page

Files

inst
inst/examples
inst/examples/knitr-subfloats.Rnw
inst/examples/download_count.csv
inst/examples/knitr-manual.lyx
inst/examples/knitr-spin.R
inst/examples/knitr-packages.bib
inst/examples/knitr-beamer.lyx
inst/examples/knitr-input-child.Rnw
inst/examples/knitr-twocolumn.Rnw
inst/examples/upload-github.R
inst/examples/knitr-latex.Rtex
inst/examples/knitr-manual.bib
inst/examples/knitr-minimal.Rrst
inst/examples/knitr-graphics.lyx
inst/examples/knitr-beamer.Rnw
inst/examples/knitr-subfloats.lyx
inst/examples/knit-all.R
inst/examples/knitr-minimal.Rmd
inst/examples/README.md
inst/examples/knitr-input.Rnw
inst/examples/knitr-minimal.Rnw
inst/examples/knitr-minimal.lyx
inst/examples/Sweavel.sty
inst/examples/knitr-graphics.Rnw
inst/examples/knitr-twocolumn.lyx
inst/examples/knitr-themes.Rnw
inst/examples/knitr-listings.lyx
inst/examples/child
inst/examples/child/sub
inst/examples/child/sub/knitr-child-c.Rnw
inst/examples/child/knitr-main.Rnw
inst/examples/child/knitr-child-a.Rnw
inst/examples/child/knitr-main.Rmd
inst/examples/child/knitr-child-b.Rnw
inst/examples/child/knitr-child.Rmd
inst/examples/child/knitr-parent.Rnw
inst/examples/knitr-themes.lyx
inst/examples/knitr-listings.Rnw
inst/examples/knitr-spin.html
inst/examples/knitr-manual.Rnw
inst/examples/knitr-minimal.brew
inst/examples/knitr-spin.Rmd
inst/CITATION
inst/misc
inst/misc/R.css
inst/misc/knitr-template.Rmd
inst/misc/tikz2pdf.tex
inst/misc/tweak_bib.csv
inst/misc/docco-template.html
inst/misc/knitr.sty
inst/misc/docco-classic.html
inst/misc/knitr-template.Rnw
inst/misc/docco-classic.css
inst/misc/Sweavel.sty
inst/misc/stitch-test.R inst/misc/gWidgetsWWW2-knitr.R
inst/misc/knitr.css
inst/misc/knitr-template.Rhtml
inst/misc/datatables.html
inst/misc/vignette.css
inst/misc/vignette.html
inst/misc/framed.sty
inst/misc/toggleR.js
inst/NEWS.Rd
inst/bin
inst/bin/knit
inst/shiny
inst/shiny/ui.R inst/shiny/server.R
inst/shiny/www
inst/shiny/www/ace-shiny.css
inst/shiny/www/ace-shiny.js
inst/doc
inst/doc/knitr-markdown.html
inst/doc/knitr-intro.html
inst/doc/datatables.Rmd
inst/doc/knitr-intro.Rmd
inst/doc/knitr-html.Rhtml
inst/doc/knit_print.R inst/doc/docco-linear.R
inst/doc/docco-classic.html
inst/doc/knit_expand.html
inst/doc/docco-linear.html
inst/doc/docco-classic.Rmd
inst/doc/knitr-markdown.R
inst/doc/knitr-markdown.Rmd
inst/doc/knitr-html.R
inst/doc/knit_print.Rmd
inst/doc/knitr-refcard.Rmd
inst/doc/knit_expand.Rmd
inst/doc/docco-linear.Rmd
inst/doc/knit_expand.R
inst/doc/knitr-refcard.pdf
inst/doc/datatables.R inst/doc/docco-classic.R inst/doc/knitr-intro.R
inst/doc/datatables.html
inst/doc/knitr-html.html
inst/doc/knit_print.html
inst/opencpu
inst/opencpu/apps
inst/opencpu/apps/index.html
inst/themes
inst/themes/rdark.css
inst/themes/edit-nedit.css
inst/themes/edit-eclipse.css
inst/themes/edit-matlab.css
inst/themes/aiseered.css
inst/themes/andes.css
inst/themes/solarized-light.css
inst/themes/edit-kwrite.css
inst/themes/golden.css
inst/themes/navy.css
inst/themes/nightshimmer.css
inst/themes/bclear.css
inst/themes/zellner.css
inst/themes/greenlcd.css
inst/themes/matrix.css
inst/themes/greyscale1.css
inst/themes/edit-xcode.css
inst/themes/fine_blue.css
inst/themes/breeze.css
inst/themes/edit-gedit.css
inst/themes/blacknblue.css
inst/themes/darkness.css
inst/themes/bright.css
inst/themes/greyscale2.css
inst/themes/edit-emacs.css
inst/themes/edit-jedit.css
inst/themes/rootwater.css
inst/themes/orion.css
inst/themes/solarized-dark.css
inst/themes/whitengrey.css
inst/themes/maroloccio.css
inst/themes/edit-vim.css
inst/themes/seashell.css
inst/themes/moria.css
inst/themes/rand01.css
inst/themes/edit-flashdevelop.css
inst/themes/darkspectrum.css
inst/themes/print.css
inst/themes/darkbone.css
inst/themes/candy.css
inst/themes/tabula.css
inst/themes/darkblue.css
inst/themes/edit-vim-dark.css
inst/themes/biogoo.css
inst/themes/greyscale0.css
inst/themes/baycomb.css
inst/themes/night.css
inst/themes/earendel.css
inst/themes/dusk.css
inst/themes/autumn.css
inst/themes/oxygenated.css
inst/themes/acid.css
inst/themes/lucretia.css
inst/themes/ekvoli.css
inst/themes/neon.css
inst/themes/moe.css
inst/themes/freya.css
inst/themes/pablo.css
inst/themes/navajo-night.css
inst/themes/dante.css
inst/themes/darkslategray.css
inst/themes/bipolar.css
inst/themes/tcsoft.css
inst/themes/olive.css
inst/themes/xoria256.css
inst/themes/manxome.css
inst/themes/fruit.css
inst/themes/bluegreen.css
inst/themes/clarity.css
inst/themes/leo.css
inst/themes/camo.css
inst/themes/denim.css
inst/themes/molokai.css
inst/themes/edit-anjuta.css
inst/themes/nuvola.css
inst/themes/vampire.css
inst/themes/zmrok.css
inst/themes/peaksea.css
inst/themes/default.css
inst/themes/easter.css
inst/themes/kellys.css
inst/themes/zenburn.css
inst/themes/relaxedgreen.css
inst/themes/anotherdark.css
inst/themes/edit-msvs2008.css
tests
tests/testit
tests/testit/test-patterns.R tests/testit/test-templates.R tests/testit/test-utils.R tests/testit/test-closure.R tests/testit/test-output.R tests/testit/test-hooks.R
tests/testit/knit-tikzDevice.Rnw
tests/testit/test-citation.R tests/testit/test-cache.R tests/testit/test-envir.R tests/testit/test-plot.R
tests/testit/knit-envir.Rmd
tests/testit/test-params.R tests/testit/test-parser.R tests/testit/test-sql.R tests/testit/test-table.R tests/run-all.R
NAMESPACE
demo
demo/gwidgets.R demo/notebook.R
demo/00Index
R
R/hooks-html.R R/defaults.R R/utils.R R/header.R R/hooks-extra.R R/output.R R/citation.R R/concordance.R R/plot.R R/utils-conversion.R R/rocco.R R/block.R R/utils-upload.R R/themes.R R/hooks-md.R R/hooks.R R/utils-rd2html.R R/hooks-textile.R R/template.R R/spin.R R/hooks-rst.R R/utils-sweave.R R/cache.R R/pattern.R R/utils-vignettes.R R/params.R R/hooks-asciidoc.R R/pandoc.R R/package.R R/table.R R/utils-base64.R R/highlight.R R/engine.R R/hooks-latex.R R/zzz.R R/parser.R R/hooks-chunk.R
vignettes
vignettes/datatables.Rmd
vignettes/knitr-intro.Rmd
vignettes/knitr-refcard.lyx
vignettes/knitr-html.Rhtml
vignettes/docco-classic.Rmd
vignettes/assets
vignettes/assets/template-refcard.tex
vignettes/knitr-markdown.Rmd
vignettes/knit_print.Rmd
vignettes/knitr-refcard.Rmd
vignettes/knit_expand.Rmd
vignettes/docco-linear.Rmd
README.md
MD5
build
build/knitr.pdf
build/vignette.rds
DESCRIPTION
man
man/knit_filter.Rd man/inline_expr.Rd man/image_uri.Rd man/pat_fun.Rd man/imgur_upload.Rd man/knitr-package.Rd man/opts_hooks.Rd man/stitch.Rd man/plot_crop.Rd man/rst2pdf.Rd man/knit2html.Rd man/spin_child.Rd man/all_patterns.Rd man/set_alias.Rd man/asis_output.Rd man/include_url.Rd man/chunk_hook.Rd man/load_cache.Rd man/knit_engines.Rd man/wrap_rmd.Rd man/clean_cache.Rd man/rand_seed.Rd man/knit_theme.Rd man/rocco.Rd man/set_header.Rd man/knit2pdf.Rd man/hook_animation.Rd man/pandoc.Rd man/hook_plot.Rd man/knit_print.Rd man/Sweave2knitr.Rd man/hook_document.Rd man/knit_watch.Rd man/knit_rd.Rd man/all_labels.Rd man/fig_chunk.Rd man/write_bib.Rd man/knit_hooks.Rd man/dep_auto.Rd man/knit.Rd man/fig_path.Rd man/include_graphics.Rd man/read_rforge.Rd man/knit2wp.Rd man/set_parent.Rd man/knit_params.Rd man/knit_child.Rd man/read_chunk.Rd man/vignette_engines.Rd man/raw_output.Rd man/spin.Rd man/knit_exit.Rd man/opts_chunk.Rd man/opts_template.Rd man/engine_output.Rd man/combine_words.Rd man/kable.Rd man/output_hooks.Rd man/knit_meta.Rd man/knit_patterns.Rd man/current_input.Rd man/opts_knit.Rd man/knit_expand.Rd man/knit_params_yaml.Rd man/dep_prev.Rd man/knit_global.Rd
tools
tools/covr.R
.Rinstignore

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.