doc for root.dir (#277)

yihui · Jun 23, 2012 · 3791f1b · 3791f1b
1 parent c89f5aa
commit 3791f1b
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/options.md b/options.md
@@ -148,6 +148,7 @@ All package options are:
 - `header`: the text to be inserted into the output document before the document begins (e.g. after `\documentclass{article}` in LaTeX, or `<head>` in HTML); this is useful for defining commands and styles in the LaTeX preamble or HTML header; the beginning of document is found using the pattern defined in `knit_patternss$get('document.begin')`
 - `out.format`: (`NULL`) possible values are `latex`, `sweave`, `html`, `markdown` and `jekyll`; it will be automatically determined based on the input file, and this option will affect which set of hooks to use (see `?render_latex` for example); note this option has to be set _before_ `knit()` runs (i.e. it does not work if you set it in the document), or alternatively, you can use the `render_*` series inside the document to set up the hooks
 - `progress`: (`TRUE`) whether to display a progress bar when running **knitr**
+- `root.dir`: (`NULL`) the root directory when evaluating code chunks; if `NULL`, the directory of the input document will be used
 - `self.contained`: (`TRUE`) whether the output document should be self-contained (TeX styles written in the tex document, and CSS styles in HTML document)
 - `upload.fun`: (`identity`) a function that takes a filename as its input, processes it and returns a character string when the output format is HTML or Markdown; typically it is a function to upload a image and return the link to the image, e.g. `opts_knit$set(upload.fun = imgur_upload)` can upload a file to <http://imgur.com> (see `?imgur_upload`)
 - `verbose`: (`FALSE`) whether to show verbose information (e.g., R code in each chunk and message logs) or just show chunk labels and options