R MarkdownでWebページを作成

R MarkdownからRStudioおよびrmarkdownパッケージの機能を用いてGitHub Pagesにサイトを構築する。RStudioの標準機能でビルドも容易に行うことができる。

10.5 rmarkdown’s site generator | R Markdown: The Definitive Guide

blogdownパッケージの検討

最近はblogdownパッケージを用いてGo言語でできたHugoというフレームワークを使って構築するのが流行りのようだが、操作が煩雑なこと、TOCをfloatにできなかったりするので単純な方法で着手する。いずれにせよコンテンツとしてはR Markdownないし素のMarkdownで作成しているため移行は簡単なはず。rmarkdownによる方法ではXXX.Rmdからbaseurl/XXX.htmlが生成され、blogdownではbaseurl/XXX/index.html(index.htmlは省略可)の形になるという違いがある。

TOC test

test section for TOC float

html_documentのオプション

blogdownではなく標準のrmarkdownパッケージによるhtml作成の利点として、出力がblogdown::html_pageではなく標準のhtml_documentなために普段と同様のオプション設定がそのまま通ることがある。特にblogdownでTOC_floatが通らないのは痛く、やはりブログ向けであってドキュメントの記載には向かない模様。

3.1 HTML document | R Markdown: The Definitive Guide

上記を参照に設定していく。サイト全体のオプションについては_site.ymlの終わりの方に記載している。

  • _site.ymlを表示するように
  • 個別のページ(index.htmlなど)でTOCの有無を変更する方法

テーマ

Bootswatch: Free themes for Bootstrapから選択してtheme: readableのように記載すれば良い。

データフレームの表示

個別ページで設定を変える

index.htmlでTOCを表示しないようにしたければ、index.Rmdのymlに

output:
  html_document:
    toc: false

としてやるだけで良い。

GitHubレポジトリでの設定

_site.ymlで出力先をdocs/にしていれば、レポジトリの設定から選んでセーブするだけ。Descriptionのところにもアドレスを入れておくと良い。

knitr::include_graphics("img/GitHub-PagesSetting.png")