Kandai.R #1 発表資料

ここは、Kandai.R #1 にて @kazutan が発表した「Rでドキュメントを生成しよう」の資料置き場です。

Rでドキュメントを生成しよう

いわゆるR Markdown入門です。スライドへのリンクはこちらです。

基本的なことをさらっと紹介しています。一番最後の参考資料にあげているのを一読してもらえればと思います。以下解説と補足です。

Markdown記法について

サンプルのmdファイルを(ちゃんと)作りました。htmlへのレンダリング結果はこちらです。実際作業するならRStudioのメニューのHelpから"Markdown Quick Reference"を選択して、Helpビューに出てくるのを見るのが一番です。

対応する出力形式について

繰り返しますが、Rmdの出力はhtmlが最強です。それ以外はメリットが半減します。またhtmlと言ってもいろいろありますし、他のパッケージでいろんなものが使えます。そのあたりについてはぼちぼちどっかでまとめるかプレゼンします。

Rチャンクについて

チャンクを挿入するには"Ctrl+Alt+I"が便利です。もしくは緑のCのボタンがありますので、これでもいいかと

あと、最近のRStudioなら、チャンク部分の一行目に歯車ボタンがあり、ここから基本的な設定が可能です:

chunkoption

よくわからなかったら、これで設定してしまってもOKです。使っていくと段々「こういうのできないのかなぁ」と思う場面が出てくるはずですので、その時に調べて学んでいければいいと思います。

yamlヘッダ

「やむる」と読むそうです。Rmdを新規で作成した時にファイル先頭に出てくる、以下のような部分です:

---
title: "Untitled"
author: "kazutan"
date: "2016/6/20"
output: html_document
---

スライドで説明したとおりですが、YAML記法でいろんなことが設定できますし、Pandocに慣れている方はここで直接Pandocにオプションを渡せます。詳しくは本家のドキュメントを参照してください。

Citationの使い方

この発表のメインその1です。

かつてはできなかったのですが、Pandocを採用してからはこの機能が実装されました。おそらく研究者にとってはこの機能は必須なものとなるはずですが、国内記事ではほとんど見かけません。なんででしょう…。

詳しくは本家の解説ドキュメントをご覧ください。文献管理をMendeleyなどで管理している方は、この機能の凄さを体感できるかと思います。要するにExportして、それをRmdの冒頭YAMLに追加すればOKです。あとは自動的に並べてくれます。対応形式も豊富ですし、論文などを執筆するならベースはRmdでやればいいはずです。

なお、発表の時に使用していたAPA.cslはこちらからDLしました。なお、パッケージとして{papaja}というのが提供されているのですが、私の手元で検証した結果、紹介を見送りました。国際誌なら全く問題ないですが、日本語を含む場合微妙でしたので…。

テンプレートの活用

この発表のメインその2です。

企画者からの指令があったので頑張りました…が、正直完璧に仕上げるのは無理でした。なおデモで使用したdocxファイルはこちら(Dropbox)においてます。Githubだとバイナリファイルがなんか崩れるっぽいので…。

テンプレートの当て方などについては本家ドキュメントを参照してください。

質問など

この内容について質問などありましたら、このリポジトリのissueもしくはTwitterの@kazutanまでおねがいします。