In Gedevan-Aleksizde/rmdja: R Markdown Formats for Japanese

(PART) 最低限のチュートリアル {-}

クイックスタート {#quick-start}

rmdja パッケージをインストールする. github からインストールするため, remotes パッケージが必要になる. 依存している rmarkdown, bookdown, knitr なども同時にインストールされる^[Windows の場合, Rtools をインストールしていないと依存パッケージがインストールされないことがある. Rtools をインストールするか, 依存パッケージを手動でインストールしてほしい].

install.packages("remotes")
remotes::install_github("Gedevan-Aleksizde/rmdja", repos = NULL)

まだ RStudio を使っていないのなら, RStudio 上で作業することを強く推奨する. さらに, もしもRの操作自体にあまり慣れていないのなら, 森知晴 『卒業論文のためのR入門』などを読むことを薦める.

加えて, 以下のパッケージが役に立つので気に入ったらインストールしていただきたい.

install.packages(c("tidyverse", "ggthemes", "citr", "clipr", "kableExtra"))

RStudio を起動し, 左上から新規作成を選び, "R Markdown" を選ぶ (図 \@ref(fig:new-file)).

knitr::include_graphics(file.path(img_dir, "new-file.png"))

"From Template" からテンプレートを選択する (\@ref(fig:rmdja-templates)).

knitr::include_graphics(file.path(img_dir, "rmd-templates.png"))

現在 (Ver. r packageDescription("rmdja")$Version) 用意されているのは以下の4つである.

• プレゼンテーション用スライド形式のテンプレート - Beamer in Japanese
• 論文形式のテンプレート - pdf article in Japanese
• 書籍形式のテンプレート - pdf book in Japanese
• 縦書き文書のテンプレート - pdf vertical writing in Japanese

動作確認として, 今回はシンプルな論文形式を選ぶ. ファイルを開いたら, 適当な名称で保存し, "knit" ボタンを押すと PDF が作成される.

下準備

以降は順を追って細かい解説をする.

より丁寧なインストール解説

文書を生成するのに必要なものをインストールする.

このドキュメントは rmdja パッケージに含まれている. よってまずはこれをダウンロードしてほしい.

remotes::install_github(
  "Gedevan-Aleksizde/my_latex_template",
  repos = NULL, type = "source")

3種類のテンプレートのうち, pdf book in Japanese のみ, 文書のビルドのための下準備が追加で必要になるため, その方法を解説する. それ以外は第 \@ref(quick-start) 節で書いたように "knit" ボタンを押すだけで良い.

最低限のファイルやパッケージで動くほうのデモ用ディレクトリをコピーする. ただし, tidyverse と kableExtra のインストールも必要である.

file.copy(
  system.file("resources/examples/bookdown-minimal",
              package = "rmdja"),
  "./", recursive = T)

書籍形式のビルド操作

書籍形式のテンプレートである pdf book in Japanese を選択した場合, 論文形式やスライド形式とは違いフォルダが作られ, その中に _bookdown.yml, _output.yml というファイルが作られる. これらは書籍の細かいフォーマットを設定するためのファイルである. 新規作成ファイルも同じフォルダに index.Rmd という名前で保存する. この名前は最初に読み込むファイル名のデフォルト名として決まっているため, 他の名前で保存すると正しく動作しないことがある. さらにbookdown の文書生成は従来の R Markdown と違い, RStudio の knit ボタンではできない. 代わりに, 以下の2通りの方法がある.

1. bookdown::render_book('index.Rmd', format = "bookdown::gitbook") などを呼び出す
2. RStudio の Build ペーンを使う

前者の場合は, Rmd ファイルのあるディレクトリに移動して以下の関数を実行する. 順にHTML, PDF, epub を出力している

bookdown::render_book("index.Rmd", "rmdja::gitbook_ja")
bookdown::render_book("index.Rmd", "rmdja::pdf_book_ja")
bookdown::render_book("index.Rmd", "bookdown::epub_book")

コピーしたディレクトリ bookdown-minimal を設定する (図 \@ref(fig:build-pane1-1), \@ref(fig:build-pane1-2)).

Build ペーンの "Build Book" の三角形を押すと, 使用できるフォーマット一覧が表示される. これはスライド, 縦書き文書, 書籍などといった文書の種類と1対1で対応しているわけではなく, フォーマット関数に対応している.

• HTML形式 - rmdja::gitbook_ja
• PDF形式 - rmdja::pdf_book_ja
• 電子書籍 (EPUB) 形式 - bookdown::epub_book

デフォルトでは "All Formats" にチェックが入っているため, これら3種類のファイル形式を一度に生成する.

include_graphics(file.path(img_dir, c("build-pane.png", "build-pane-build.png")))

これで _book フォルダに出力がされる.

Gedevan-Aleksizde/rmdja documentation built on Sept. 28, 2021, 2:49 a.m.