序文

注意!

現在, このドキュメントは煩雑で rmdja パッケージの更新に対して追いついていません. あまり信用しないでください.

R Markdown 全般の使用例については以下を参考にしてください. これらは R Markdown 開発の中心人物が執筆しているためこのページよりも信頼できます.

日本語で書かれた書籍には以下があります.

一旦残り2作の翻訳を済ませてから, これらで言及されていない使用法 (特にPDFでの日本語の適切な表示方法など) について本稿で補足説明したいと思います. それまではこちらのドキュメントはほとんど更新されないことに注意してください.

長大な技術文書や良質な技術文書を作成するには手間がかかる. しかし時間をかければ良い文書になるわけではない. 無駄な手間を省き, 効率よく快適に文書を作成するべきである.

たとえばこういう経験はないだろうか.

  • プログラムの解説のため, 外部サービスでシンタックスハイライトしてもらったテキストをコピーペーストで貼り付ける
  • グラフや図解を専用アプリケーションで作成し貼り付ける. 修正のたびに貼り付け直す
  • 図表に言及する際に「図 1」「表 2」と番号をタイプし, 参照先へハイパーリンクを指定する
  • 本文中で引用した参考文献のリストを巻末にコピーペーストし, 過不足がないか目視で確認
  • \(\sum_{k=1}^K\int_0^\infty f_k(x) dx\) などといった複雑な数式はプレーンテキストや HTML では表現できないため, 画像を生成して貼り付ける
  • 冒頭にかっこいいエピグラフを掲載したいので, 1時間かけて特別に枠やフォントを作成した
  • 市販のワードプロセッサで作成した文書を渡したら, レイアウトが崩れて読めないと言われた

本稿は文書作成者をこのような数え切れないブルシットから解放するのが目的である.

R Markdown (rmarkdown) は, R プログラムを埋め込んだ動的なドキュメントから pandoc を利用して PDF や HTML 形式の文書を作成するパッケージであり, 数式, 図表の挿入, シンタックスハイライトされたプログラムなどを簡単な記述で掲載できる. 名前の通り, その基本構文は Markdown である. よって, Markdown と R の知識が最低限あれば (R プログラムが必要ないなら Markdown だけでも) 文書を作成することができる.

bookdown パッケージは rmarkdown をもとに, ページ数の多い文書を作成し, 配布するための機能を拡張したものである. しかし, PDF の出力に関しては欧文を前提としたフォーマットを使用しているため, 日本語の適切な表示 (組版やフォントの埋め込みなど) のできる文書を作成するには高いハードルが存在した.

本稿では, rmarkdown および bookdown で日本語文書を作成する際の設定を容易にしたパッケージ rmdja を利用した日本語技術文書の作成方法を解説する. 現在, 書籍, 論文, プレゼンテーションの体裁での文書を作成するテンプレートが用意されており, このドキュメント自体も rmdja を利用して作成されている.