Commit cf0098c3 authored by Raniere Silva's avatar Raniere Silva Committed by GitHub
Browse files

Merge pull request #79 from fmichonneau/add-r-pkgs

add more information about pkgs needed to build the lesson
parents d980e91c 51021348
Loading
Loading
Loading
Loading
+46 −18
Original line number Diff line number Diff line
@@ -10,15 +10,32 @@ objectives:
keypoints:
- "It shouldn't be difficult"
---

This episode demonstrates all the features that can be used when writing a
lesson in [RMarkdown][r-markdown].

This first chunk is really important, and should be included in all markdown lessons.
To generate the site, you will need to have the following packages installed:


```r
install.packages(c("knitr", "stringr", "checkpoint"))
```

If the lesson uses additional packages, the script that converts the Rmd files
into markdown, will detect them and install them for you, when you run `make
serve` or `make site`.

This first chunk is really important, and need to be included at the beginning of
each episode written in RMarkdown.


~~~
source("../bin/chunk-options.R")
~~~
{: .r}

The rest of the lesson should be written as a normal RMarkdown file. You can
include chunk for codes, just like you'd normally do:
include chunk for codes, just like you'd normally do.

Normal output:

@@ -55,19 +72,6 @@ Output generating figures:

~~~
library(ggplot2)
~~~
{: .r}



~~~
Warning: package 'ggplot2' was built under R version 3.1.3
~~~
{: .error}



~~~
ggplot(diamonds, aes(x = carat,  y = price, color = cut)) +
    geom_point()
~~~
@@ -75,9 +79,33 @@ ggplot(diamonds, aes(x = carat, y = price, color = cut)) +

<img src="../fig/rmd-plot-example-1.png" title="plot of chunk plot-example" alt="plot of chunk plot-example" style="display: block; margin: auto;" />

For the challenges and their solutions, you need to pay attention to the where
the `>` go and where to leave blank lines. Otherwise, you can include chunks in
it to include instructions and solutions.
For the challenges and their solutions, you need to pay attention to where the
`>` go and where to leave blank lines. You can include code chunks in both the
instructions and solutions. For instance this:

```
> ## Challenge: Can you do it?
>
> What is the output of this command?
>
> 
> ~~~
> paste("This", "new", "template", "looks", "good")
> ~~~
> {: .r}
>
> > ## Solution
> >
> > 
> > ~~~
> > [1] "This new template looks good"
> > ~~~
> > {: .output}
> {: .solution}
{: .challenge}
```

will generate this:

> ## Challenge: Can you do it?
>
+38 −6
Original line number Diff line number Diff line
@@ -10,17 +10,29 @@ objectives:
keypoints:
- "It shouldn't be difficult"
---

This episode demonstrates all the features that can be used when writing a
lesson in [RMarkdown][r-markdown].

This first chunk is really important, and should be included in all markdown lessons.
To generate the site, you will need to have the following packages installed:

```{r, eval=FALSE}
install.packages(c("knitr", "stringr", "checkpoint"))
```

If the lesson uses additional packages, the script that converts the Rmd files
into markdown, will detect them and install them for you, when you run `make
serve` or `make site`.

This first chunk is really important, and need to be included at the beginning of
each episode written in RMarkdown.

```{r, echo=FALSE}
```{r, echo=TRUE}
source("../bin/chunk-options.R")
```

The rest of the lesson should be written as a normal RMarkdown file. You can
include chunk for codes, just like you'd normally do:
include chunk for codes, just like you'd normally do.

Normal output:

@@ -42,9 +54,29 @@ ggplot(diamonds, aes(x = carat, y = price, color = cut)) +
    geom_point()
```

For the challenges and their solutions, you need to pay attention to the where
the `>` go and where to leave blank lines. Otherwise, you can include chunks in
it to include instructions and solutions.
For the challenges and their solutions, you need to pay attention to where the
`>` go and where to leave blank lines. You can include code chunks in both the
instructions and solutions. For instance this:

```
> ## Challenge: Can you do it?
>
> What is the output of this command?
>
> ```{r, eval=FALSE}
> paste("This", "new", "template", "looks", "good")
> ```
>
> > ## Solution
> >
> > ```{r, echo=FALSE}
> > paste("This", "new", "template", "looks", "good")
> > ```
> {: .solution}
{: .challenge}
```

will generate this:

> ## Challenge: Can you do it?
>