Another communicate re-org

This commit is contained in:
hadley 2016-08-22 16:08:16 -05:00
parent ae0cb9b7f7
commit b972ad6ba9
5 changed files with 61 additions and 63 deletions

View File

@ -35,8 +35,8 @@ rmd_files: [
"communicate.Rmd",
"rmarkdown.Rmd",
"communicate-plots.Rmd",
"workflow-rmarkdown.Rmd",
"rmarkdown-exts.Rmd"
"rmarkdown-formats.Rmd",
"rmarkdown-workflow.Rmd",
]
before_chapter_script: "_common.R"

View File

@ -8,67 +8,24 @@ So far, you've learned the tools to get your data into R, tidy it into a form co
knitr::include_graphics("diagrams/data-science-communicate.png")
```
Your audience might be:
Communication is the theme of the following four chapters:
* Fellow practioners who want to reproduce your work.
* Decision makers want to understand your findings in plain English.
* Future-you who will be thankful if you make your work easy to re-learn
and recreate
In this part of the book, you will learn about:
* RMarkdown, a tool that allows you to easily combine prose and code to
construct reproducible reports where the inputs and outputs are always
in sync.
* In [R Markdown], you will learn about R Markdown, a tool for integrating
prose, code, and results. You can use R Markdown in notebook mode for
analyst-to-analyst communication, and in report mode for
analyst-to-decision-maker communication. Thanks to the power of R Markdown
formats, you can even use the same document for both purposes.
* Presentation techniques for visualsiation. When creating exploratory graphics,
you want to be able to iterate as quickly as possible, so you'll typically
stick to ggplot2's defaults. When you're communicating to others, you'll
want to think through every aspect of your plot in order to make it as
easy to understand as possible.
## What you will not learn
There are two important topics that you will not learn here: collaboration, and how to express yourself clearly.
Collaboration is a vital part of modern data science, and you can make your life much easier by using version control tools, such as Git and Github. We recommend two free resources that will teach you about Git:
1. "Happy Git with R": a user friendly introduction to Git and GitHub from
R users, by Jenny Bryan. The book is freely available online:
<http://happygitwithr.com>
1. The "Git and GitHub" chapter of _R Packages_, by Hadley. You can also
read it for free online: <http://r-pkgs.had.co.nz/git.html>.
We're also not going to give you the human tools for communication. But here are a few recommendations:
* If you want to improve your writing, I highly recommend reading either
[_Style: Lessons in Clarity and Grace_](https://amzn.com/0134080416), or
[_The Sense of Structure: Writing from the Reader's Perspective_](https://amzn.com/0205296327) by George Gopen. Both books will help you understand the structure of sentences and
paragraphs and give you the tools to make your writing more clear. (These
books are rather expensive if purchased new, but they're used by many English
classes so there are plenty of cheap second-hand copies available.)
* In [Graphics for communication], you will learn how to take your exploratory
graphics and turn them into expository graphics, graphics that help the
newcomer to your analysis understand what's going on as quickly and
easily as possible.
George Gopen also has a number of short articles on writing at
<http://georgegopen.com/articles/litigation/>. They are aimed at lawyers,
but almost everything applies to data scientists too.
* In [R Markdown formats], you'll learn a little about the many other varieties
of outputs you can produce using R Markdown, including dashboards, websites,
and books.
* To improve your presentation skills, I recommend
[_Presentation Patterns_](https://amzn.com/0321820800), by Neal Ford,
Matthew McCollough, and Nathaniel Schutta. It provides a set of effective
patterns (both low- and high-level) that you can imply to improve your
presentations.
* If you give academic talks, I recommend reading the [_Leek group guide
to giving talks_](https://github.com/jtleek/talkguide).
* I haven't taken it personally, but I've heard good things about Matt
McGarrity's online course on public speaking:
<https://www.coursera.org/learn/public-speaking>.
* Finally, effectively communicating your ideas often benefits from some
knowledge of graphic design. [_The Non-Designer's Design
Book_](http://amzn.com/0133966151) is a great place to start.
* We'll finish up with [R Markdown workflow], where you'll learn a fourth
workflow in which R Markdown takes center stage.
Unfortunately these chapters focus mostly on the technical mechanics of communication, not the really hard problems of communicating your thoughts to other humans. However, there are lot of other great books about communication, which we'll point you to at the end of each chapter.

View File

@ -1,4 +1,4 @@
# Extensions
# R Markdown formats
```{r setup, include = FALSE}
chunk <- "```"
@ -178,3 +178,25 @@ Learn more about Shiny at the [Shiny Development Center](http://shiny.rstudio.co
## Books
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).
## Learning more
* To improve your presentation skills, I recommend
[_Presentation Patterns_](https://amzn.com/0321820800), by Neal Ford,
Matthew McCollough, and Nathaniel Schutta. It provides a set of effective
patterns (both low- and high-level) that you can imply to improve your
presentations.
* If you give academic talks, I recommend reading the [_Leek group guide
to giving talks_](https://github.com/jtleek/talkguide).
* I haven't taken it personally, but I've heard good things about Matt
McGarrity's online course on public speaking:
<https://www.coursera.org/learn/public-speaking>.
* Finally, effectively communicating your ideas often benefits from some
knowledge of graphic design. [_The Non-Designer's Design
Book_](http://amzn.com/0133966151) is a great place to start.

View File

@ -1,4 +1,4 @@
# Workflow: RMarkdown
# R Markdown workflow
You have seen three basic workflows:

View File

@ -4,6 +4,11 @@
R Markdown provides an unified authoring framework for data science, combining your code, its results, and your prose commentary. R Markdown documents are fully reproducible and support dozens of output formats, like PDFs, Word files, slideshows, and more. RMarkdown files are designed to be used in two ways:
You can use R Markdown in notebook mode for
analyst-to-analyst communication, and in report mode for
analyst-to-decision-maker communication. Thanks to the power of R Markdown
formats, you can even use the same document for both purposes.
1. To produce a final report that you can share with others.
1. As a notebook, which allows yout to mingle prose, code, and output during
@ -373,3 +378,17 @@ csl: apa.csl
```
As with the bibliography field, your csl file should contain a path to the file. Here I assume that the csl file is in the same directory as the .Rmd file. <http://github.com/citation-style-language/styles> contains many useful CSL style files.
## Learning more
There are two important topics that we haven't covered here: collaboration, and the details of accurately communicating your ideas to other humans. Collaboration is a vital part of modern data science, and you can make your life much easier by using version control tools, such as Git and Github. We recommend two free resources that will teach you about Git:
1. "Happy Git with R": a user friendly introduction to Git and GitHub from
R users, by Jenny Bryan. The book is freely available online:
<http://happygitwithr.com>
1. The "Git and GitHub" chapter of _R Packages_, by Hadley. You can also
read it for free online: <http://r-pkgs.had.co.nz/git.html>.
I have also not touched about what you should actually write in the prose in order to clearly communicate the results of your analysis. To improve your writing, I highly recommend reading either [_Style: Lessons in Clarity and Grace_](https://amzn.com/0134080416), or [_The Sense of Structure: Writing from the Reader's Perspective_](https://amzn.com/0205296327) by George Gopen. Both books will help you understand the structure of sentences and paragraphs, and give you the tools to make your writing more clear. (These books are rather expensive if purchased new, but they're used by many English classes so there are plenty of cheap second-hand copies.) George Gopen also has a number of short articles on writing at <http://georgegopen.com/articles/litigation/>. They are aimed at lawyers, but almost everything applies to data scientists too.