Fundamental of Data Science for EESS

layout: true
background-image: url(img/course-logo.png), url(img/logo_SBR.png), url(img//NTU-Logo-full-colour.png)
background-position: right top 30px,  right 50px bottom 50px,left 50px bottom 50px, top 350px left 500px 
background-size: 45%, 25%, 20%

# Fundamentals of Data Science for EESS

---

## R session 02 - R markdown

2021-01-20

---
layout: false
class: inverse

# Outline

---
layout: true

# Installation and Resources

* rmarkdown (will install also knitr)
* tinytex (Latex)

## Resources
* On-line Book: https://bookdown.org/yihui/rmarkdown

* Cheat sheet: https://www.rstudio.com/wp-content/uploads/2015/02/rmarkdown-cheatsheet.pdf
]

<img src="img/R-markdown-book.png" width="65%" style="display: block; margin: auto;" />
]

---
layout: false
background: url(img/logo-markdown.png)

# What is markdown ?

.center[
<img src="img/markdown-John_Gruber.jpg" width="20%" /><img src="img/markdown-Aaron_Swartz.jpg" width="20%" />
]

* Created in 2004 by [John Gruber](https://en.wikipedia.org/wiki/John_Gruber) and [Aaron Swartz](https://en.wikipedia.org/wiki/Aaron_Swartz)

* Goal : "to write using an easy-to-read and easy-to-write plain text format, optionally convert it to structurally valid HTML".

## Many flavors...

* MultiMarkdown
* GitHub Flavored Markdown (GFM)
* Pandoc
* CommonMark

---

# Rmarkdown

## Mix

* Markdown
    - paragraph structure
    - comments
    - links

* R code ("chunks")

* Output of R code

---

# Your first Rmarkdown file

---
.student[Who has not been able to install Rmarkdown and Latex ?]

---

![](img/R-markdown_new.gif)

---

## Knit to HTML

---

---

## Knit of pdf

---
<img src="img/package-rmarkdown-pdf-output.png" width="100%" />

---
layout: true
# Markdown syntax

---

* Quick guide: https://www.markdownguide.org/basic-syntax/

## Headings

```r
# Heading - level 1

## Heading - level 2
```
--
 
## Heading - level 1
 
### Heading - level 2

---

## Paragraphs

```r
Paragraphs are separated
by a blank line.

Two spaces at the end of a line  
produces a line break.
```
--

Paragraphs are separated
by a blank line.

Two spaces at the end of a line  
produces a line break.

---

## Formatting

```r
_italic_, *italic*, **bold**, `monospace`.
```

_italic_, *italic*, **bold**, `monospace`.

---

## Bullet lists

```r
Bullet list:

* apples
  * oranges
  * pears
      * passe crassane (4 spaces to indent)
```

* apples
* oranges
* pears
    * passe crassane

---

## Numbered lists

```r
Numbered list:

1. wash
1. rinse
1. repeat
```
--

1. wash
1. rinse
1. repeat

---

## Hyperlinks

```r
  [Text of the link](URL of the link)

# Example
  [Markdown syntax](https://www.markdownguide.org/basic-syntax/)
```

[Markdown syntax](https://www.markdownguide.org/basic-syntax/)

---

## Images

```r
  ![Image name](URL of the link - can also be a local file on your computer)

# Example
  ![](https://i.pinimg.com/originals/1c/b7/24/1cb724b545de717ed0430e9d46e78eea.jpg)
```

![](https://i.pinimg.com/originals/1c/b7/24/1cb724b545de717ed0430e9d46e78eea.jpg)

---

## Tables

```r
ID | First | Last
--- | --- | ---
1 | Jo | Biden
```

ID | First | Last
--- | --- | ---
1 | Jo | Biden

---

# Rmarkdown conversion

* [Pandoc](https://pandoc.org/) : command line tool

* Converts from **md** to **pdf**, **html**, **docx**...

```r
# HTML
> pandoc test1.md -f markdown -t html -s -o test1.html

# pdf
> pandoc test1.md -s -o test1.pdf
```
]

<img src="img/pandoc.png" width="100%" style="display: block; margin: auto auto auto 0;" />
]

---

# The Rmarkdown file

---

## File structure

---

## Knit process

---

## Output

---

# R Chunks

---

## Insert R chunk

---

## Run R chunk

* Two options

---

## Option 1: Run R chunk inside Rmd file

- Use when building and debugging an Rmd file

---

## Option 2: Knit R chunk to HTML

- Use for final production

---

## Options for R chunks

---
exclude: false

## Useful options

Options | Default value | Aim
--- | --- | ---
echo | TRUE | Print code (= FALSE in a report for example)
eval | TRUE | Evaluate code (= FALSE if want to show code only)
warning  | TRUE | Warning message (= FALSE to remove long warnings)
message  | TRUE | Messages (= FALSE to remove long messages)
cache   | FALSE | If TRUE only modified chunks will be evaluated
   |  |  very useful for computing heavy codes
fig.height  |  |  inches
fig.width  |  |  inches

---
exclude: false

## Set defaults options

* Insert in a R chunk at the beginning of your Rmarkdown file
* Option CACHE = true reduce compiling time

```r
  knitr::opts_chunk$set(fig.width=6, fig.height=6, 
                        eval=TRUE, 
                        cache=TRUE,
                        echo=TRUE,)
```

---
exclude: false

# What can you do with Rmarkdown ?

---
background-image: url(img/R-markdown-document-01.png), url(img/R-markdown-document-02.png)
background-position: right 20px bottom 20px, left 20px bottom 20px
background-size: 40%, 50%

## Document your data analyses

* If the data changes, you can re-run analysis in a matter of minutes
* More and more journal request analyses scripts

---
exclude: false
background-image: url(img/package-xaringan-example.png)
background-position: right 20px top 20px
background-size: 60% 
## Presentation

https://github.com/yihui/xaringan

]

---
exclude: false
background-image: url(img//package-posterdown-example.png)
background-position: right 20px top 20px
background-size: 60%

## Posters

.left-column[
<img src="img/package-posterdown-logo.png" width="60%" />
https://github.com/brentthorne/posterdown
]

---
exclude: false
background-image: url(img/package-vitae-example-02.png)
background-position: right 20px top 20px
background-size: 50%

## Curriculum vitae

https://cloud.r-project.org/web/packages/vitae/index.html
]

---
background-image: url(img//web-site-pr2.png)
background-position: bottom 20px right 20px  
background-size: 45%
exclude: false

## Website

https://bookdown.org/yihui/blogdown/
 
]

---
layout: false
class: inverse

# What did you learn ?

--
.font150[
- Can be used for many different purposes
]

--
.font150[
- Use to document your analysis process (for papers...)
]