TeX & LaTeX Advent Calendar 2015 の22日目の記事です。昨日は @termoshttさんの「今さら人に聞けない、Beamerの基本 」でした。
これまでの担当の方々に比べるとLaTeX力が圧倒的に少ないのですが、今日は、主に統計解析のために利用されるR言語でLaTeXが役立っている点についての記事を書くことでLaTeX職人さんたちに感謝の気持ちを伝えたいと思います(え。また、Rユーザーの方には少しでもRとLaTeXの相性の良さを伝えられればと思います。LaTeXで脱わーどを目指しましょう。
RユーザーがLaTeXを使うべき理由
LaTeXユーザーの方には言わずもがなですが、Rを使っている人でLaTeXも使う、という人は案外少ないように感じます。ですが、今回の記事で書くように、RとLaTeXを組み合わせることでより強力な表現ができたりしてあれこれ捗ります(多分)。月並みですが、LaTeXの良さとして以下にあげるものがあると思います。
- LaTeXで書かれたドキュメントは綺麗(体裁的な意味を含む)
- 豊富なパッケージでドキュメントを彩れる
- 数式を表現するのに便利
最近では、RMarkdownファイルを活用して、Rコードや実行結果を含めたドキュメントを作成する方も増えているかと思います。その時にLaTeXを使うと大変便利です、という話を以下にしていきます。
RMarkdownファイルでのLaTeXを利用したPDF出力を極める
今やRでドキュメントを作成する際には常套手段となっている.Rmdファイルでは、YAML部分でLaTeX形式での出力を指定することで、(環境さえ整っていれば)簡単にRmd -> (TeX) -> PDFというような形式での出力が可能です。
おさらいとして.RmdファイルでPDFを出力する際のYAMLヘッダーの書き方を見てみましょう。
title: "example"
output: pdf_document
これはYAMLでの連想配列と呼ばれる表記の仕方で、titleがキーとなり、コロンの後に続くexampleが値を意味しています。出力 outputのキーにPDFを指定する、というわけですね。
PDFとして出力する際には、いくつかのオプションが利用可能です。ちょっと書き方が変わりますが、先ほどと同様にYAMLを編集します。
title: "example"
output:
pdf_document:
toc: true
toc_depth: 2
pdf_documentのキーにオプションとなるキーを入れ子に記述します。ここで、toc
は目次を表示するオプションで、値がtrueなので表示する指定をします。またtoc_depth
は目次の深さを指定するオプションとなっております。今回は2なので\subsection{}
に与えた見出しまで(markdownでは##に該当)を目次に載せます。
その他、PDF出力で設定可能なオプションは次のものがあります。
項目 | 概要 | 値(既定値) |
---|---|---|
number_sections |
見出しに番号をつける | 論理値 (false) |
fig_width |
出力時の図のサイズ(幅) | 実数値 (6) |
fig_height |
出力時の図のサイズ(高さ) | 実数値 (4.5) |
fig_crop |
図の余白を切り落とすpdfcropを有効にする | 論理値 (true) |
fig_caption |
図に脚注をつける | 論理値 (false) |
dev |
出力する図の拡張子 | |
highlight |
Rコードなどのハイライトに用いるテーマ | default1 |
latex_engine |
レンダリングに用いるLaTeXエンジン | pdflatex2 |
keep_tex |
.texファイルを保存する | 論理値 (false) |
includes |
in_header, before_body, after_bodyそれぞれで挿入するtexファイルを指定 | --- |
template |
レンダリング時に任意のテンプレートを利用する際に指定 | --- 3 |
pandoc_args |
レンダリング時に実行されるpandocのオプション | --- |
このほかにtango, pygments, kate, monochrome, espresso, zenburnとhaddockが指定可能↩
xelatexやlualatexも指定できる↩
https://github.com/jgm/pandoc-templates/blob/master/default.latex このファイルがテンプレートになっている↩
また、pdf_documentのキーとは独立して指定するオプションもあります。これらはLaTeXテンプレートに影響を与えるようなオプションになっています。LaTeXユーザーにはおなじみのオプションですね。
- header-includes
- fontsize
- geometry
- lang
- documentclass
- classoption
- geometry
- mainfont
- sansfont
- monofont
- mathfont
- linkcolor
- urlcolor
- citecolor
- bibliography
- csl
日本語を含んだRMarkdownファイルをPDF出力する
以前に記事としてまとめていますが、YAMLを以下のように指定すれば、最低限の日本語PDFが出力されます。
header-includes:
- \usepackage{zxjatype}
- \setjamainfont{Hiragino Kaku Gothic Pro}
output:
pdf_document:
latex_engine: xelatex
ここでは、日本語を表示させるためにzxjatype
パッケージを利用しています。
LaTeXパッケージでRMarkdownを彩る
さて、Rと同様、LaTeXにも豊富なパッケージがあります。これらを利用することであなたのドキュメントはより綺麗に、より簡単に文書を書くことが可能になっていくでしょう。ここでは私が頻繁に利用しているオススメのパッケージを紹介します。
-
fontspec
... 簡単に複数の種類のフォントをドキュメント内で表現することができます。 -
natbib
... 参考文献リストを作成する際に便利です。 -
coloremoji
およびbxcoloremoji
... 絵文字を出力します。自分が使っているツールで「寿司」を表現したい、という気持ちはLaTeXユーザーもRユーザーも変わりません。
我田引水ですが、以下の記事もご覧ください。
ついに念願の「knitrで生成したPDF上で絵文字を出力する」ことに成功したぞ - まだ厨二病
LaTeX文書中に絵文字的なもの(Font-Awesome)を取り入れる - Qiita
RMarkdownでBeamer
Rユーザーの方にBeamerの説明を少しだけします。Beamerとはスライド資料作成のためのLaTeXクラスファイルの一種であり、文字のレイアウトなど細かい点を気にせずに、なおかつLaTeXの記法が利用できてしまう大変便利なものです。(ちょっと見た目がシンプルすぎる気もしますが...)
昨日の @termoshttさんの記事がタイムリーでした。興味を持たれた方は是非一読あれ。
RMarkdownをBeamer出力するにはYAMLには
output: beamer_presentation
を追加するだけです。
俺々テンプレート
またも手前味噌で恐縮ですが、RMarkdownのテンプレートとして、便利なLaTeXパッケージや設定を導入したパッケージを開発しています。最初は本当に個人用に作成したものでしたが、GitHubで星をつけてくれる人がいて、モチベーションの向上につながっています。
このようなドキュメントがLaTeXの力を借りて作成できるようになります(ここから拡張していくこともできます)。
プロットに数式を埋め込む際には{latex2exp}
パッケージを使うのが良い
以前ぞうさん通信で紹介されていたのですが、いまいち盛り上がりがないような**{latex2exp}
**パッケージ。便利なパッケージなのでここで紹介したいと思います。
皆さんRのプロット中に数式を埋め込んだり、タイトルや軸ラベルに対し、太字にしたり字下げを行ったりした経験が一度はあるかと思います。その際にRではexpression()
やplotmath()
関数を使って数式を表現することになりますが、なんだか覚えにくくありませんか。特に私のようなLaTeXユーザーだと、慣れているTeXの表現と異なるので面倒臭さが倍増します。
{latex2exp}
パッケージではそんな煩わしさを取っ払って、LaTeX記法を利用して図の中に数式を埋め込んだりできます。
# install.packages("latex2exp")
library(latex2exp)
簡単な使い方
LaTeXではコマンドの入力時にはバックスラッシュを使うのがお約束になっていますが**{latex2exp}
パッケージでは、そのお約束に加え、更にバックスラッシュを必要とします。すなわち、2重バックスラッシュで数式を定義する必要があります。また数式のインライン表示を行う際の$で囲うという規則も{latex2exp}
**で有効です。すなわち、
を表現する場合にはTeX("$\\alpha$")
とします。
TeX("$\\alpha$")
# expression(`$\alpha$` = paste("", "", alpha, , , , ""))
TeX()
関数に渡す値がLaTeX記法で表現したい数式になります。TeX()
を軸のラベルや図中に埋め込むことで簡単に数式を表現できます。また数式部分だけをプロットすれば、LaTeXiT.app
のように数式の図が作れます。
curve(dnorm, from = -3, to = 3, main = "Normal Distribution")
text(x = 0, y = 0.1,
TeX("$\\y = \\frac{1}{\\sqrt{2 \\pi}} \\e ^{-\\frac{x^2}{2}$"))
# text(x = 0, y = 0.1,
# expression(italic(y == frac(1, sqrt(2 * pi)) * e ^ {-frac(x^2, 2)})))
plot(TeX("I $\\heartsuit \\LaTeX$ and R"),
cex = 2, col = "magenta1")
RStudioでtexファイルを編集する
そんなことも可能です。シンタックスハイライトも有効です。コンパイルまでできます。
というわけで、Rを使うならLaTeXも覚えようね、という記事でした。
いつもわかりやすいLaTeXの記事を書いてくれる方や素敵なパッケージを開発してくださる皆さんに感謝です。明日の担当は @doraTeX さんです。楽しみですね。
個人的なところでは、来年はもっとTeX力を高めたいです...。
参考
- 高橋康介 (2014). ドキュメント・プレゼンテーション生成. 共立出版.
- PDF Documents
- YAML フォーマット - Symfony