RMarkdown

R
RStudio

R Markdown

• R Markdown
  • MarkdownのHelp
  • 見出し
  • 書体
  • 文字の色
  • 特殊文字
  • 箇条書き
  • 横線
  • そのまま
  • 数式
  • 引用
  • 表
  • ヘッダー部分の設定
    • 使用例
  • chunkコード
    • 文書全体にわたるオプションのデフォルトの設定は、最初に
    • Rのコード
    • コードのオプション
    • 警告を出さない
    • メッセージを出さない
    • プロットの結果出力のオプション
    • インラインコード
  • その他
    • 画像の挿入
    • コメント
  • 書き終わったら、上の Knit をクリックすると、レポートが作成される。
    • グラフのサイズの調整：fig.width=インチ, fig.height=インチ
    • knitディレクトリーに注意
  • BibTeX 文献の引用と文献リストの作成
    • 準備
    • 執筆
    • 出力
  • 論文の原稿を作る際のコツ
    • Writing Reproducible Research Papers with R Markdown すばらしい
  • References

• メニューのファイルの下、左端の＋マークから、R Markdownを選ぶ
• メニューのFileからNew File で選ぶ
  • Text File を選んでおいて、ファイル保存時に、拡張子 .rmd を付けて保存する。

MarkdownのHelp

• メニューのHelpから Markdown Quick Reference を選ぶ

見出し

# Header 1

## Header 2

### Header 3

#### Header 4

書体

*italic*   **bold**

_italic_   __bold__

^上付き文字^

~下付き文字~

~~打消し~~

<U>下線</U>

文字の色

• HTMLで指定する

<font color = "red">このデータを使用</font>

特殊文字

• RMarkdownの中で使われる特殊文字のエスケープはバックスラッシュ一つ

\*
\#

箇条書き

* 項目
* 項目

1. 番号付き
2. 番号付き
3. 番号付き

• 階層は、前に四つスペース

* 項目
    * 下位項目
    * 下位項目

横線

---

そのまま

```
そのままの文
そのままの文
```

数式

$$

y = a * x^b

freq = 7592 * rank^{-0.6}

$$

引用

> 引用文
> 引用文

表

• 縦棒で区切る
• 一番上が見出し
• 二行目が配置の設定（コロンの位置）
  • コロンが左　左寄せ
  • コロンが右　右寄せ
  • コロンが左右　中央（|:---:|）

|指標|説明|
|:----|:---|
| i| ファイル名|
| Score| Criterionスコア|
| Tokens| 総語数|
| Types| 異なり語数|
| NoS| 文数|
| TTR| 語彙多様性|
| GI| 語彙多様性|
| MATTR| 語彙多様性|
| AWL| 平均単語長（文字数）|
| ASL| 平均文長（単語数）|

 ヘッダー部分の設定

• https://qiita.com/kazutan/items/726e03dfcef1615ae999
• https://bookdown.org/yihui/rmarkdown/html-document.html

subtitle:
abstract:

theme:

• theme一覧

https://bootswatch.com/3/

使用例

title: "JSLS2023e"
subtitle: "言語特徴をStageごとで統合しない分析"
abstract: "PT言語特徴とTOEFLスコア、発話量などについて分析してみた。"
author: "sugiura"
date: "2023-02-09"
output:
  html_document:
    toc: true
    theme: cerulean
    number_sections: true
---

 chunkコード

文書全体にわたるオプションのデフォルトの設定は、最初に

knitr::opts_chunk$set()

で、設定しておく。

• RMarkdownのファイルを作るとデフォルトで

knitr::opts_chunk$set(echo = TRUE)

となっている。

Rのコード

```{r}
ここに書く
ここに書く
ここに書く
```

コードのオプション

• ```{r sample} のように名前を付けておくこともできる

• ```{r, include=FALSE} コードは実行されるが、コードも結果も表示されない

• ```{r, echo=FALSE} コードを表示せず、実行結果だけ出力

• ```{r, eval=F}　コードは表示されるが実行されない

• ```{r, results='hide'}　コードは実行されるがKnitのレポートには表示されない

警告を出さない

warning=F

メッセージを出さない

message=F

プロットの結果出力のオプション

• fig.height = 7

• fig.width = 7

• fig.align = "left"

• fig.cap = "キャプション"

• dpi = 72

インラインコード

• 文中に `r コードを描く` としておけば、コードの実行結果がそこに出力される。

 その他

画像の挿入

• Rmdソースコードと同じフォルダーに入れておくのが簡単

![表示される文字](画像ファイル名)
![NICER1.3](NICER1_3info.png)

• 画像のサイズの調整 {width=80%}

コメント

<!--
コメント部分
-->

• 命令を書く部分（code chunk）では、該当行を選んでおいて、Ctrl+Shift+C

 書き終わったら、上の Knit をクリックすると、レポートが作成される。

• HTMLでの書き出しでのオプション
  • toc: true で目次作成
  • toc_float: true で左に目次表示
  • number_sections: true で見出しに通し番号付与

output:
  html_document:
    toc: true
    toc_float: true
    number_sections: true

author: "sugiura"
date: "2022/11/11"
output:
  html_document:
    toc: yes
    number_section: yes
  word_document:
    toc: yes
  pdf_document:
    toc: yes

• html_document: のところ、コロン忘れずに

グラフのサイズの調整：fig.width=インチ, fig.height=インチ

```{r, fig.width=15, fig.height=10}

knitディレクトリーに注意

• RMarkdownで記述しながら、Chunkを実行していく際に、スクリプトやコンソールで設定している作業ディレクトリーとは別に、Knit Directory で設定するディレクトリーが別にあるので注意。
  • Document Directory
  • Project Directory
  • Current Working Directory
• スクリプト内で setwd()で作業ディレクトリーを変更しても、チャンク内の一連の処理が終わったら、また、元のディレクトリーに戻ってしまう。
• Knit Directoryが変更されない限り、ドキュメント内での作業ディレクトリーは、チャンク内のsetwd()でセットしたディレクトリーではなくKnit Directoryで設定されているディレクトリーのままになっている。Knitのメニューから手動で変更する必要がある。

 BibTeX 文献の引用と文献リストの作成

• なんと、LaTeXのように使える。

準備

• 参考文献をBibTeX形式のテキストファイル（例 LCR.bib）で用意し、RStudioで読み込んでおく。
  • 文字コードはUTF-8にしておく。SHIFT-JISだとエラー。

@article{lijffijt2012correction,
  title={Correction to Stefan Th. Gries’“Dispersions and adjusted frequencies in corpora”, International Journal of Corpus Linguistics},
  author={Lijffijt, Jefrey and Gries, Stefan Th},
  journal={International Journal of Corpus Linguistics},
  volume={17},
  number={1},
  pages={147--149},
  year={2012},
  publisher={John Benjamins}
}

@article{gries2008dispersions,
  title={Dispersions and adjusted frequencies in corpora},
  author={Gries, Stefan Th},
  journal={International journal of corpus linguistics},
  volume={13},
  number={4},
  pages={403--437},
  year={2008},
  publisher={John Benjamins}
}

@incollection{gries2010dispersions,
  title={Dispersions and adjusted frequencies in corpora: further explorations},
  author={Gries, Stefan Th},
  booktitle={Corpus-linguistic applications},
  pages={197--212},
  year={2010},
  publisher={Brill}
}

• Rmarkdownのヘッダー部分で、bibliography: LCR.bib のように、使用するファイルを指定する。

output:
  html_document:
    toc: yes
    number_section: yes
  word_document:
    toc: yes
  pdf_document:
    toc: yes
bibliography: LCR.bib

執筆

• RMarkdown文書中で、引用個所をLaTeXのように、記述する。
  • @の後ろに各文献の引用コードを書く。

@lijffijt2012correction は、@gries2008dispersions の訂正記事です。

@gries2010dispersions にもまとめが書いてあります。

出力

• ただ普通に、Knitするだけ。
• 本文中に著者名と年号が挿入され、

• 文書の最後に、参考文献一覧が整形されて付け足される。
• 文書の最後に「 # References」と書いておけば、その下に、文献一覧が並ぶ。

 論文の原稿を作る際のコツ

• セクションの見出しは　#
• サブセクションは、##
• コードチャンクに、それが何をするものか説明を書いておく

```{r エクセルファイルからデータ読み込み}

• 数式はTeX形式で表記可能
• 図の出力は、plot()でなく、チャンクオプションで、デバイスで画像出力

```{r, dev="png"}

• 二種類ほしかったら

```{r, dev=c("png", "jpg")}

https://www.njtierney.com/post/2018/02/28/three-r-tips/

• 最初から、全部

knitr::set_opts(dev = "jpg")

Writing Reproducible Research Papers with R Markdown すばらしい

https://resulumit.com/teaching/rmd_workshop.html

 References

• https://gihyo.jp/admin/serial/01/r-markdown/0002
• https://gihyo.jp/admin/serial/01/r-markdown/0003

https://epirhandbook.com/jp/rmarkdown.html

• https://mom-neuroscience.com/r-rmarkdown/
• https://blog.atusy.net/2021/01/21/rmd-bs4/
  • スタイルの変更
• 宋財泫 (Jaehyun Song)・矢内勇生 (Yuki Yanai)「私たちのR: ベストプラクティスの探究」https://www.jaysong.net/RBook/
• R Markdown: The Definitive Guide

https://bookdown.org/yihui/rmarkdown/

• R Markdown from RStudio

https://rmarkdown.rstudio.com/lesson-1.html
https://kazutan.github.io/kazutanR/Rmd_intro.html#r_markdown%E3%81%AE%E6%9B%B8%E3%81%8D%E6%96%B9
https://www.docswell.com/s/3818391906/521P6K-2022-04-16-132212#p1
https://youtu.be/dbljY7jxrSA