knitrBootstrapを使ってHTMLレポートをかわいくする
- 19. 今回の作業環境
• R(3.2.2)(≧ 3.0.0)
• RStudio(0.99.446)
• knitr(1.11)(≧1.4.1)
• markdown(0.7.7)(≧ 0.5.5)
• knitrBootdtrap(0.9.0)
※ 赤字はユーザーズガイド記載の対応しているバージョン
- 26. 3.knitrBootstrapの使い方
出力方法 ① の例
26
# .Rmd→.md
knit_bootstrap_Rmd( “ファイル名.Rmd”,
boot_style = “Amelia”, # スタイルの名称
chooser = c( “boot“ , ”code“ ),
show_figure = FALSE,
encoding = “UTF8“ ) # 文字コードの指定
# .md→.HTML
knit_bootstrap_md( “ファイル名.md“ , encoding = "UTF8“ )
日本語を含む場合は文字コード指定!
.Rかコンソールa
※ Macユーザは必要なさそうです
- 27. 3.knitrBootstrapの使い方
出力方法 ② の例
27
```{r setup, echo=TRUE, include= FALSE}
library( “knitr” )
render_html()
```
options( rstudio.markdownToHTML =
function( inputFile, outputFile ) {
require( knitrBootstrap )
knit_bootstrap_md( input=inputFile, output=outputFile,
boot_style = "Amelia",
chooser = c( "code“ , "boot“ ),
show_figure = FALSE ,
encoding = "UTF8“ )
} ) # knit HTMLボタンの裏で機能している関数を設定している
.RProfilea
.Rmdaaaa
Rのホームフォルダか
R Projectフォルダに
置いておく
.Rmdの始めのチャンク
に書いておく
Notes de l'éditeur
- よろしくお願いいたしします。
今回私が発表させていただくテーマは、
Rでのレポート作成についてで
特に、KnitrBootstrapというパッケージを使って
HTMLレポートのみためを簡単にかわいくする!
ということについてお話しさせていただきます。
見た目がよくなるだけじゃなくて、
もちろん、使い勝手も便利になるんですが、
私がこのパッケージを気に入った理由が
とにかく見た目がかわいいという理由だったので
こーゆータイトルにしました。
今回はRstudioを使うことを前提として話をさせていただきます。
ご了承ください。
- よくわかんなくてもとりあえずかっこいい技をみてもらおう!と思いました。
こんなカッコイイコトができちゃうんだよ!ということをご紹介して
- 本日の内容です。
今回は、KnitrBootstrapのご紹介
RでHTMLレポート作成を作成するための基礎
knitrBootstrapの使い方
Rでレポート作成のススメ
の4本立てでお話しします。
- では、まず始めにknitrBootstrapを使ってつくったレポートが
どんな風に魅力的かお伝えしたいと思います。
- そもそもKnitrBootstrapがどんなものかといいますと、
すごくざっくり説明すると、
WebサイトやWebアプリをつくって、それをデザインするときに使用されている
Bootstrapというツール集を
RのHTMLレポート作成に適用させたパッケージ です。
例えば、何かwebサイトを作ったけど、自分で一からセンスよくデザインするのが難しい。
そんなときにBootstrapを使ってカスタマイズすると、全体的にまとまりのいい
おしゃれなページにすることができる。という感じです。。。
それを、Rの世界でも使えるようにと作られたパッケージです。
では、実際に
Rで作ったHTMLレポートにknitrBootstrapを適用させるとどう変わるのか、
ということをご覧ください。
- よくわかんなくてもとりあえずかっこいい技をみてもらおう!と思いました。
こんなカッコイイコトができちゃうんだよ!ということをご紹介して
- では、このようなレポート作成をするためには
どうしたらよいか詳しい説明に入っていきたいと思います。
まず、RでHTMLレポートを作成するための基礎知識をご説明いたします。
自分なりにわかりやすく説明できるように頑張りますが、
やはり専門用語を聞いたらうんざりしてしまうという方は耳をふさいでもらって大丈夫です。
この次の実際の使い方から聞くのを再開してください!
- RでHTMLレポートを作成するための流れは
こんな感じです。
普段、Rでデータ解析をするときは、拡張子がRになっているスクリプトファイルを作りますが、
HTMLレポートを作成するときは.RmdのRマークダウンファイルからスタートします。
Rスクリプトファイルからいろんな関数を使ってHTMLファイルをつくることもできますが、
こちらのほうが一般的です。
このRmdファイルからhtmlファイルを作るためには一度.mdというマークダウンファイルを経由するんですが、
最近のRstudioだと.mdファイルをいちいち出力せずにできる。
.mdファイルの説明を省ければいいんですが、
今のところknitrBootstrapを使う場合、一度mdファイルを出力しないとhtmlを出力できないようになっています。
Knithtmlボタンを使えば一瞬ですが、裏では関数がいろいろと仕事をしてくれています。
とにかく、Rmdファイルをなんとかしてhtmlファイルに変換することで
RでHTMLレポートを作ることができます。
- RでHTMLレポートを作成するための流れは
こんな感じです。
普段、Rでデータ解析をするときは、拡張子がRになっているスクリプトファイルを作りますが、
HTMLレポートを作成するときは.RmdのRマークダウンファイルからスタートします。
Rスクリプトファイルからいろんな関数を使ってHTMLファイルをつくることもできますが、
こちらのほうが一般的です。
このRmdファイルからhtmlファイルを作るためには一度.mdというマークダウンファイルを経由するんですが、
最近のRstudioだと.mdファイルをいちいち出力せずにできる。
.mdファイルの説明を省ければいいんですが、
今のところknitrBootstrapを使う場合、一度mdファイルを出力しないとhtmlを出力できないようになっています。
Knithtmlボタンを使えば一瞬ですが、裏では関数がいろいろと仕事をしてくれています。
とにかく、Rmdファイルをなんとかしてhtmlファイルに変換することで
RでHTMLレポートを作ることができます。
- では、knitrBootstrapがこの中でどんなはたらきをしてくれるのかといいますと、
それぞれのファイルにBootstrapで装飾するという命令を書きくわえてくれます。
knitrBootstrapを使う場合は、元のrmdファイルからスタートして図の中の赤い矢印のルートを通って
Bootstrapで装飾されたhtmlファイルの出力にたどり着くことが目標です。
図の中の赤い矢印のルートを通るための関数が
knitrBootsrtapパッケージの中に入っています。
×と△の矢印についてですが
×そのルートで出力できる関数がありません。 △はできなくもないが微妙な仕上がりです。
なんとなくそれっぽく出力ができても、knitrbootstrapの機能の一部しか使えなくなってしまいます。
元のファイルから、目的のhtmlファイルまで、常にbootstrapを適用できる
関数を使うことが重要です。
- では、knitrBootstrapがこの中でどんなはたらきをしてくれるのかといいますと、
それぞれのファイルにBootstrapで装飾するという命令を書きくわえてくれます。
knitrBootstrapを使う場合は、元のrmdファイルからスタートして図の中の赤い矢印のルートを通って
Bootstrapで装飾されたhtmlファイルの出力にたどり着くことが目標です。
図の中の赤い矢印のルートを通るための関数が
knitrBootsrtapパッケージの中に入っています。
×と△の矢印についてですが
×そのルートで出力できる関数がありません。 △はできなくもないが微妙な仕上がりです。
なんとなくそれっぽく出力ができても、knitrbootstrapの機能の一部しか使えなくなってしまいます。
元のファイルから、目的のhtmlファイルまで、常にbootstrapを適用できる
関数を使うことが重要です。
- ではいよいよ実際の使い方をご説明いたします。
- 私がknitrBootsitapを使ったときの各バージョンはこんな感じです。
全て最新かな?と思います。
赤字の方がkniterBootsitapのユーザーズガイドに書かれていた、対応しているバージョンです。
ですが、実際わたしがRの3.2.1でknitrBootdtrapを使おうとするとうまくいかなかったので、
最新のバージョンにアップデートしたほうが良いかと思います。
- 実際にknitrBootstrapパッケージを使ってHTMLレポートを出力するための手順です。
1) 必要なパッケージをインストール&ロードする
2)レポートの元になる.Rmdファイルを作成する
3)knitrBootdtrapの関数を使って
.htmlファイルを出力する
だけです。
出力する手順は2通りご紹介いたします。
- 使用するパッケージはだけですknitrBootdtrapです。
インストールして、読み込んでおいてください。
- そしてもとになるRmdファイルを作成しておいてください。
Rマークダウンファイルの書き方については申し訳ないですが今回は説明しません。
Rmarkdownについてわかりやすく説明している書籍もwebページもたくさんありますので、
どうぞそちらで見てみてください。
とにかくすぐにやってみたいという方は、Rmdファイルを新規作成したときに書かれている
サンプルコードをそのまま使うだけで十分に試してみることができるので
始めはそれでやってみてください。
- 出力方法その1は、先ほどもお話ししましたように、
RmdからBootstrapで装飾されたhtmlファイルを作成するまでの経路をひたすら
関数を使ってファイルを出力していく方法です。
- もうひとつの方法はRstudioのknitr HTMLボタンを使ったHTMLファイルの出力を
デフォルトでBootstrap仕様に設定する方法です。
この方法では、
.RprofileというR起動時のオプションを設定するファイルを作成、
Rのホームフォルダか設定を適応したいRprojectフォルダ内においておきます。
そしてRmdファイルに特定のコードを入力すれば毎回ワンクリックで
HTMLファイルにBootstrapを適用することができます。
- knitrBootstrapの関数オプションです。
boot_styleは全体のスタイル設定、code_styleはコード部分のスタイル設定で、
それぞれスタイル名を文字列データで指定します。
入力しなければ出力するたびに、コンソールで、どのスタイルを指定するのか聞いてきます。
Chooserはbootとcodeの選択肢の表示です。Bootかcode、もしくは両方を指定すると
レポート作成後もスタイルを自由に変えられます。
Thumbsize画像のサムネイルの大きさ設定
show_code、show_output、show_figure
はそれぞれ出力時に表示しておくかどうかtrueをorFALSEで設定できます。
どちらに設定してもhtmlレポートの作成時には
いつでもオンオフをスイッチできます。
関数が違ってもオプションはどれも同じです。
- 方法①の出力例です。
Rmd、からmd、mdからhtmlを順に2つを順番に出力します。
このとき、オプションを設定するのはどちらかの一方の関数で大丈夫です。
注意しなければならないは文字コードの指定で、レポートが日本語を含む場合は
Rmdをutf8で作成し、出力オプションでも常にエンコードディングで指定してください。
- 方法2では、
Rprofileを作成します。
拡張子がrprofileのファイルをRのホームフォルダか
R Projectフォルダに置いておくとRstudio起動時に指定した設定が読み込まれます。
ここでは、なにを指定しているかというと、
rstudio.markdownToHTMLというはおそらく
knit HTMLボタンの裏で働いている関数です。
markdownToHTMLというのは、
Mdファイルをhtmlに変換する関数ですので、
knit HTMLボタンを押したときに起こっているこの変換部分で
Knitrbootstrapパッケージを読み込むnod
Bootstrapの様式を適用する。という設定です。
日本語のレポートを作成するときはこのときも必ず文字コードを指定してください。
このファイルをフォルダにおいて、Rstudioを立ち上げと
下の部のコードを含むrmdファイルを指定して
Knithtmlボタンをクリックするをワンクリックで
Bootstrapが適用されたHTMLレポートを出力することができます。
よく使う方は方法2のほうが便利です。
方法1も2も、実行すれば
始めにお示ししたような設定のHTMLレポートを出力することができます。
- 最後、Rでレポート作成のススメをほんの少しだけ
- 従来のレポート作成では・・・
その点、Rでレポート作成をすると・・・
レポート作成時間の削減
人為的なミスの削減
間違いの見つけやすさの向上
解析コードの可読性の向上
今回の発表で今まで興味なかったけどやってみようかなと思った方は
ぜひぜひ楽しみながらご自分の研究に役立ててみてください。
- きんめいてつさん