Frequently Asked Questions

2017-02-17

This FAQ is compiled from the issues and messages I received from blog posts and emails, etc. Personally I’m not big fan of FAQ’s, and I believe sometimes FAQ’s are nearly bugs, so I wish to keep the list short.

  1. knitr does not work…

    • Please first update all your R packages (use update.packages()) and probably R itself (what is the current R version?), then see if it works; if not, please file an issue to me with a minimal reproducible example and the output of xfun::session_info('knitr').

  2. What is the best place to ask questions when the package website is not helpful?

    • Depending what you want to ask, you may use these tools (I keep track of the first two more frequently):
      • (Recommended) Stack Overflow: general questions (more experts and quicker answers there). Don’t forget to use both the tags r and knitr.
      • GitHub issues: bug reports and feature requests only.
      • Private emails are not recommended unless there are really private issues.
      • Twitter (@xieyihui) if you really believe it is a simple question.

  3. What is the best editor for writing knitr source documents?

  4. Where are those prompt characters > and +? I feel uncomfortable reading R output without them.

    • They are removed by default, because I believe they make no sense. This is the reason why I dislike books on R which used > and +; they twist my mind and make my eyes bleed when I read the R code in the books. For those who really want to read R code like > 1+1 instead of 1 + 1, you have the chunk option prompt.

  5. What is the working directory? Can I change my working directory in my code chunks?

    • You’d better not do this. Your working directory is always getwd() (all output files will be written here), but the code chunks are evaluated under the directory where your input document comes from. Changing working directories while running R code is a bad practice in general. See #38 for a discussion. You should also try to avoid absolute directories whenever possible (use relative directories instead), because it makes things less reproducible. If you do still decide to use setwd in a code chunk, beware that the new working directory will only apply to that specific code chunk, and any following code chunks will revert back to use the original working directory.

  6. The gray (shading) box is too narrow for my output.

    • No, it is not because the box is too narrow (the box uses the current line width); it is because your output is too wide. Use a smaller width option to avoid text output exceeding the page margin, e.g. options(width = 60) (see example 038).

  7. How can I write a literal / verbatim code chunk? i.e., write a code chunk that is not parsed (which can be useful for tutorials).

    • For code chunks, you can use the verbatim engine, e.g.,

      ````{verbatim}
```{r, eval=TRUE}
1 + 1
```
````

    • For inline R code, you may use the function knitr::inline_expr(). If you are writing an R Markdown document, you can use a trick: break the line right after `r (no spaces after it), and wrap the whole inline expression in a pair of double backticks, e.g.,

      This will show a verbatim inline R expression `` `r
1+1` `` in the output.

      See this post for explanations if you are curious.

  8. How can I submit a documentation fix or other minor changes?

    • To fix anything in the R package: navigate to the file within the repository; click the Edit button on the top-right toolbar; make the necessary changes; add a descriptive commit summary, click on Propose file change, and submit the pull request.
    • To fix anything or propose changes on any page of this website, please click on the menu Edit this page on the left of the page, and follow the same steps on GitHub.