研究を伝えるためのRノート

このブログ投稿では、R ノートブックを使用して研究を伝達し、その結果を提示する方法について見ていきます。このチュートリアルから、R ノートブックを使用してあらゆる種類の研究結果を報告し、伝達するためのフレームワークが得られることを期待しています。

これを行うことには、特に再現可能な研究という考えに関して、いくつかの大きな利点があります。これが何を意味するのか、そして R ノートブックでそれを行う方法については後で説明します。

目次

• 再現性とは何ですか?
• R ノートブックの開始
• R ノートブックのパッケージの紹介
• R ノートブックに動的参照を追加する
• 結論

再現性とは何ですか?

再現性の考え方は、誰でも調査結果を監査でき、使用した入力とプロセスがあれば、全体を確認できるはずだということです。データ分析のニーズにこれが役立つ方法はいくつかあります。それは、物事を再現可能にする環境、人々が投稿内容を確実に確認できること、ファイルを簡単に監査できること、再現可能なパブリッシャーの存在です。

理想的には、レポートにどのように到達したか、使用したプロットやテーブルがどのように生成されたかを誰かが正確に確認できるため、すべてが完全に再現可能な環境になります。

ここで、 LuckyTemplatesやExcelのようなものがこれにどのように当てはまるのか疑問に思われるかもしれません。この再現可能なワークフローの途中にあると言えます。特にパワークエリについて考えると、再現性が非常に優れています。関連するプロセスが一目瞭然である適用ステップについて考えてみましょう。

ビジュアライゼーションとレポートに関しては、ここが少し複雑になります。R ノートブックはRStudio の一部です。LuckyTemplates ポータルには、すぐに使い始めるためのコースがあります。このR MarkdownとR Notebooksについて説明します。

Jupyter ノートブックに詳しい方ならわかると思いますが、テキストとコードを散在させて研究用のストーリーテリング ドキュメントを作成できるという考え方です。

これらの結果をさまざまな出力でレンダリングできるようになります。PDF を作成する必要がある場合でも、HTML にレンダリングする必要がある場合でも、R Notebook はさまざまなファイル形式に使用できます。

まず、R ノートブックを開き、RStudio で [ファイル]、[新しいファイル]、[R ノートブック] の順に移動します。次の非常に単純な研究課題を使用して、リソース内の古いデータセットを使用して作業します。

コンピュータの価格は、CD-ROM の有無によって決まりますか?

この質問は時代遅れですが、私たちは皆、どこかから始めなければなりません。また、研究報告書の骨格を定め、この基本的な枠組みを用いて研究成果を発表します。

RStudio では次のようなものが表示されます。これは .rmd ファイルと呼ばれるもので、R マークダウン ファイル拡張子です。特に慣れていない場合は少し不快に感じるかもしれませんが、洗練された最終製品をプレビューする方法があります。

ノートブックのこの部分は、YAML ファイルと呼ばれるメタデータです。

このセクションの後には、コードが挿入されるバックテキストがあります。次に、 R Markdownを使用したドキュメントのテキスト部分があります。以前に Markdown を使用したことがある場合、R Markdown はかなり似ています。アスタリスクやハッシュ記号などを使用して、テキストをマークアップしてレンダリングできます。

R Studio と R Notebooks に移動して、この分析を一緒に見てみましょう。歯車をクリックし、「ビューア ペインでプレビュー」と表示されていることを確認します。

R ノートブックの開始

「プレビュー」ボタンをクリックすると、保存するように求められます。繰り返しますが、これは RMD ファイルなので、最初に保存する必要があります。左側のペインに、レンダリングされた出力が表示されます。ここで何かを変更し、「Computers Analysis」のようなものを記述し、 George Mountのような著者名を追加する場合は、引用符で囲む必要があります。

「保存」をクリックすると、これに自動的に更新されます。

それでは、これで遊んでみましょう。ここにはすでにいくつかのプレースホルダーがありますが、これは問題ありません。最初に「CD-ROM は販売価格に影響しますか?」と入力します。これを保存するとHeader1になります。しかし、これを 2 つのハッシュ マークにすると、Header2 になり、サイズが小さくなります。

次のステップは、「はじめに」を実行することです。ここで、このことが重要である理由を入力できます。たとえば、CD-ROM が次善の策であるとか、そのようなことが言えます。消費者レポートに取り組んでいる場合、またはマーケティング部門で働いている場合は、どの機能が本当に重要であるか、消費者が何を求めているかを把握しようとしています。

R パッケージを呼び出して開始します。ここで私が気に入っている点の 1 つは、R Notebook で実際に HTML を使用できることです。たとえば、自分自身にコメントを残したい場合は、次のようにすることができます。

これを保存すると、まったく表示されません。したがって、これを自分自身へのコメントとして本文に残しておきます。これは MS Word のような場所で実現できればいいのにと思います。

R ノートブックのパッケージの紹介

次のステップでは、このコード プロットを使用して、いくつかの設定を追加します。Python と SQL を使用できますが、この例では R を使用しています。

必要なパッケージをすべて読みます。これらがコンピュータにない場合は、インストールする必要がある場合があります。

繰り返しますが、これは完全なレポートではありません。R Markdown について知っておくべきことをいくつか示すために、スケルトンを見ていきます。

そこでここでは、データをどこで取得するのか、そしてそれがなぜ重要なのかを紹介します。この場合、情報源は Journal of Applied Econometrics であると言えます。このアスタリスクを実行すると、斜体に変わります。

次に、Excel でファイルを読み取り、R を使用してそれを取り込みます。ご覧のとおり、データはすでにかなり良好に見えます。これが R Notebooks のもう 1 つの優れた点です。

出力形式によっては、これが表示される場合もあります。HTML を使用している場合、ユーザーは実際にデータを参照し、基本的な操作を行うことができます。これらをライブドキュメントで実際に実行できるのは素晴らしいことです。

R ノートブックに動的参照を追加する

ここで、データのテキストに動的参照を含めたいとします。これはレポートを作成するたびに同じではない可能性があるため、定期的に更新する必要があります。したがって、ここではテキスト内で動的参照をインラインで作成します。

これらすべてのコードにはチートシートとリファレンスガイドがあります。ヘルプに移動し、R Markdown の設定を選択すると、さまざまな設定をすべて調べることができます。たくさんあるので、それを覚えようとする価値はおそらくなく、代わりにこれを使用するだけで十分です。

R チャンクを再度挿入し、FALSE、nrows、およびncolsを含めます。

これが実行されて実行されると、R 環境にアクセスして、それがオブジェクトに変換されたかどうかを確認することもできます。

もう 1 つの便利な点は、アイデアを検討しているだけで、それが実際にどのようになるかを知りたい場合は、下部にあるコンソールを使用するだけで済むことです。コンソールで実行して、出力がどのように表示されるかを確認できます。

ビューア ペインに戻ります。さて、このセクションはレポートにまったく表示されません。これは、オブジェクトを使用したいがコードをまったく表示したくない場合に便利です。

動的に保つために、nrows と ncols でこれらのバック テキストを使用します。PDF レポートがあり、これらの数値を毎週ハードコーディングするのではなく、自動的に変更する必要がある場合は、これらのインライン参照を使用できます。

私たちは再びデータを調査し、コンピューターの価格を確認しているところです。

このコードを実行すると、すべて適切にフォーマットされた記述統計が表示されます。データのサイズに応じて、ファイルのサイズに非常に敏感に反応します。

結論

このチュートリアルでは、再現可能な研究を開発し、R ノートブックを使用して研究結果を伝達するプロセスを合理化することの重要性について説明しました。このようにして、元の結果を迅速かつ簡単に再現し、その結果がどのように導出されたのかを追跡することができます。 

このチュートリアルの続きは、このシリーズのパート 2 にあるのでご注目ください。

ジョージ・マウント