search

Gedevan-Aleksizde / rmdja

R Markdown/Bookdown の日本語用フォーマット
https://gedevan-aleksizde.github.io/rmdja/
BSD 3-Clause "New" or "Revised" License
15 stars 6 forks source link
beamer bookdown japanese-language latex pandoc r rmarkdown tokyo-r

readme

What’s this?

Customized R Markdown/Bookdown format functions for Japanese users

なにこれ

以下は rmdja 自身で作成したドキュメントです. HTML/PDF も用意しています.

最低限必要なもの

インストールから使用まで

  1. 後述の必要なパッケージや外部プログラムをインストールする

  2. このパッケージをインストールする (remotes パッケージを使うのが簡単です)

    remotes::install_github('Gedevan-Aleksizde/rmdja', upgrade = "never")

    注: 最近は master が更新されていませんので, development ブランチからのインストールを推奨します. テストが不完全なため master に反映していないだけなので, 基本的には master より development のほうが改良されています. 具体的には以下のようにします.

    remotes::install_github('Gedevan-Aleksizde/rmdja@development', upgrade = "never")

    特定のバージョンをインストールする場合は, 以下のようにして指定できます. remotes::install_github('Gedevan-Aleksizde/rmdja', ref="v0.4", upgrade = "never") または以下のような記法も可能です remotes::install_github('Gedevan-Aleksizde/rmdja@v0.4', upgrade = "never")

    @development は開発中のバージョンです. 新機能が追加されてる場合もありますがバグも多いです. ソースコードを理解して適宜修正できる自信のある方のみ使用してください.

    remotes::install_github('Gedevan-Aleksizde/rmdja@development', upgrade = "never")

    Windows OS では Rtools をインストールしていない場合, 上記 remotes::install_github() では依存パッケージを自動インストールしてくれないことがあります. Rtools をインストールするか, 依存パッケージを手動でインストールしてください. 必要なパッケージは DESCRIPTION の Imports の項目に書かれています.

    install.packages(c("rmarkdown", "bookdown", "commonmark", "styler"))

    リリース一覧からダウンロードしたアーカイブファイルからインストールすることもできます.

  3. TeX 環境を未インストールなら, ここでインストールします これはそれなりに時間がかかります. また, 初回のコンパイルにも追加ダウンロードで時間がかかるかもしれません.

    tinytex::install_tinytex()

  4. 新規作成時に [R Markdown] -> [From Template] -> {rmdja} のテンプレートのいずれかを選択します template selection

  5. フォントの指定 (オプション)

    • OSごとの違いはほぼデフォルトのフォントだけです. もしフォントが表示されない/気に入らない場合は手動で指定してください. 例えば,
    • MS (Win10) なら
    jfontpreset: bizud
    • Ubuntuなら
    jfontpreset: noto
    • Noto が入ってない, または Ubuntu 以外の Linux なら
    jfontpreset: haranoaji
    • macなら
    jfontpreset: hiragino-pro

    でとりあえずは動くはずです.

    • XeLaTeX をお使いなら zxjafont, LuaLaTeX をお使いなら luatex-ja のプリセット名で指定できます
    • 混植も可能です
    • 詳しくは examples/beamer 以下の pdf を確認してください.

NOTE: jmainfont, jsansfont, jmonofont で書体ごとにフォントを設定できます. mainfont/sansfont/monofont は欧文用です. 特に monofont/jamonofontはソースコードの掲載に使われます. プログラムの解説をしたい場合はM+やRictyなどのインストールを推奨します

NOTE: 現時点での XeLaTeX 版と LuaLaTeX 版の違いは以下のとおりです.

  1. 一部のLaTeXコマンドが違う
  2. 文字の相対的な大きさ, 字間などのレイアウトが微妙に違う
  3. LuaLaTeX のほうがやや処理が遅い
  4. 縦書き文書は LuaLaTeX のみ対応

初期バージョン (rmdCJK) をお使いの場合

名称を変更したため旧バージョンは不要になります. アンインストールしてください

remove.packages("rmdCJK")

用途によっては追加インストールが必要なもの

(u)pBibTeX を使用したい場合

フォントについて

日本語フォントを指定しなかった場合 (jfontpreset 未設定, かつj~~fontの設定が3つ揃っていない場合), OSを判別して以下のようにデフォルトフォントを決めています. これらは (Linux 以外) OS標準インストールフォントのはずです.

Mac Ubuntu windows (8以降) windows(それ以前) それ以外
XeLaTeX 游書体 Noto 游書体 MSフォント 原ノ味
LuaLaTeX ヒラギノProN Noto 游書体 MSフォント 原ノ味

Ubuntu 18 以降の設定に準拠して Noto-CJK をデフォルトにしています. 他の Linux 系 OS ならば, TeX Live 2020 以降で同梱されている原ノ味フォント (haranoaji) がデフォルトになるようにしています.

なお, Noto フォントのインストール方法は以下のようにします

Ubuntu/Debian:

sudo apt install fonts-noto-cjk-extra -t stretch-backports

Cent OS とか Fedora とか:

https://www.google.com/get/noto/help/install/

NOTE: monofont/jamonofontはソースコードの掲載に使われます. M+やRictyなどのインストールを推奨します

注意事項

サンプルの内容を再現したい場合

examples/ 以下に用例がいくつか存在します.

*.pdf はそれぞれに対応する出力例です.

各OSでよく使われるフォントを指定している以外は上記は全て同じです. 適当なディレクトリに上記いずれかをコピーしてknitしてみてください. コピーする際には

file.copy(system.file("resources/examples/beamer/beamer_xelatex.Rmd", package = "rmdja"), to = "./")
file.copy(system.file("resources/examples/beamer/beamer_lualatex.Rmd", package = "rmdja"), to = "./")

と言うふうにコピーすると楽です.

NOTE: 用例の一環として, knit時に同じフォルダに tab.tex, examples.bib, .latexmkrc というファイルが生成されます. 上書きに注意してください.

examples に必要なRパッケージ

install.packages(
  c("conflicted", "rmarkdown", "tidyverse", "ggthemes", "ggdag", "DiagrammeR", "xtables", "kableExtra", "stargazer", "tufte"),
  dependencies = T)
install.packages("webshot")
webshot::install_install_phantomjs()

examples に必要な外部プログラム

DOT言語で生成した画像を挿入する用例があるため, インストールが必要です

MAC:

brew install graphviz

Ubuntu:

sudo apt install graphiviz

謝辞

この場を借りて感謝します

その他

2020/9/19 Tokyo.R で本パッケージの機能を紹介しました.

『おまえは万物をRSTUDIOで書ける』

更新履歴メモ

その他開発メモ

TODO: ロードマップ, すこし難しいが追加したい機能

将来やってみたいこと. 詳細なスケジュール未定.

[1] 2019以前をお使いで, これから更新する場合は追加の手続きが必要らしいです. 参考: https://text.baldanders.info/remark/2020/04/haranoaji-fonts-with-texlive-2020/