Skip to content

Commit

Permalink
Minor rmarkdown tweaking
Browse files Browse the repository at this point in the history
  • Loading branch information
hadley committed Aug 23, 2016
1 parent e29e3a5 commit 44512f1
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 6 deletions.
20 changes: 16 additions & 4 deletions rmarkdown-formats.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -252,15 +252,27 @@ Read more at <http://rmarkdown.rstudio.com/rmarkdown_websites.html>.

## Other formats

The bookdown package extends R Markdown to create book length documents, like *R for Data Science*, which was written with R Markdown and bookdown. To learn more about bookdown, see the free ebook [Authoring Books with R Markdown](https://bookdown.org/yihui/bookdown/) or [www.bookdown.org](www.bookdown.org).
Other packages provide even more output formats:

There are a few Journal specific formats bundled together in the __rticles__ package, <https://github.com/rstudio/rticles>.
* The __bookdown__ package, <https://github.com/rstudio/bookdown>,
makes it easy to write books, like this one! To learn more, read
[_Authoring Books with R Markdown_](https://bookdown.org/yihui/bookdown/),
by Yihui Xie, which is, of course, written in bookdown. Visit
<http://www.bookdown.org> to see other bookdown books written by the
community.

You can also create your own formats <http://rmarkdown.rstudio.com/developer_custom_formats.html>.
* The __prettydoc__ package, <https://github.com/yixuan/prettydoc/>,
provides lightweight document formats with a range of attractive
themes.

* The __rticles__ package, <https://github.com/rstudio/rticles>, compiles a
selection of formats tailored for specific scientific journals.

See <http://rmarkdown.rstudio.com/formats.html> for a list of even more formats. You can also create your own by following the instructions at <http://rmarkdown.rstudio.com/developer_custom_formats.html>.

## Learning more

To learn more about communcating in thse different formats I recommend:
To learn more about communcating in these different formats I recommend:

* To improve your presentation skills, I recommend
[_Presentation Patterns_](https://amzn.com/0321820800), by Neal Ford,
Expand Down
4 changes: 2 additions & 2 deletions rmarkdown.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ chunk <- "```"
inline <- function(x = "") paste0("`` `r ", x, "` ``")
```

## R Markdown basics
## R Markdown workflow

This is an R Markdown file, a plain text file that has the extension `.Rmd`:

Expand All @@ -62,7 +62,7 @@ To produce a complete report containing all text, code, and results click "Knit"
knitr::include_graphics("screenshots/rmarkdown-report.png")
```

When you __knit__ the document R Markdown sends the .Rmd file to [knitr](http://yihui.name/knitr/), which executes all of the code chunks and creates a new markdown (.md) document which includes the code and its output. The markdown file generated by knitr is then processed by [pandoc](http://pandoc.org/) which is responsible for creating the finished format. The big advantage of this two step workflow is that you can create a very wide range of output formats, as you'll learn about in XYZ. Knitting is performed in a fresh instance of R which ensures that your reports are completely reproducible.
When you __knit__ the document R Markdown sends the .Rmd file to [knitr](http://yihui.name/knitr/), which executes all of the code chunks and creates a new markdown (.md) document which includes the code and its output. The markdown file generated by knitr is then processed by [pandoc](http://pandoc.org/) which is responsible for creating the finished format. The big advantage of this two step workflow is that you can create a very wide range of output formats, as you'll learn about in [R markdown formats]. Knitting is performed in a fresh instance of R which ensures that your reports are completely reproducible.

```{r, echo = FALSE, out.width = "100%"}
knitr::include_graphics("images/RMarkdownFlow.png")
Expand Down

0 comments on commit 44512f1

Please sign in to comment.