RでQuartoを使用する際の個人的覚書

今回は、R普及チャットボット「Rはいいぞ」さんと対話的に進行していきます。

https://chatgpt.com/g/g-8SyJH1UaN-rhaiiso

Quartoについて

＜Quartoってなんですか？＞

Quartoは、Rや他の言語でデータサイエンスや分析を行う際に使用される強力なフレームワークです。QuartoはRMarkdownの進化形として開発され、より柔軟で多機能なドキュメント生成ツールとなっています。Quartoを使用することで、RやPythonなどのコードと文章を組み合わせたレポートや論文、プレゼンテーション、ウェブサイトなどを簡単に作成することができます。

＜RMarkdownの進化形なんですね。何が進化してるんですか？＞

QuartoはRMarkdownの利便性を保ちつつ、さらに多機能で柔軟なフレームワークを提供します。複数言語のサポート、豊富な出力形式、拡張性の高いテンプレートシステム、プロジェクト管理機能など、データサイエンスやドキュメント作成の幅を大きく広げる進化が見られます。

これにより、Quartoはより複雑なプロジェクトや多言語環境においても強力なツールとなり、データ分析のドキュメント作成を一段と効率的に進めることができます。RMarkdownのユーザーにとっても、Quartoへの移行は多くのメリットをもたらすでしょう。

使用方法

＜簡単に使用方法について説明してください。＞

各.qmdファイルで個別に分析を行い、必要に応じて設定やパッケージを活用して効率的に作業を進めることができます。ここでは、Quartoを使用して個別の分析を行うための基本的な設定と方法を紹介します。

Quartoドキュメントの基本設定

1. Quartoドキュメントの作成

RStudioで新しいQuartoドキュメントを作成します。

新しいファイルを作成:
- RStudioのメニューから File > New File > Quarto Document を選択します。
- 適切な名前を付けて保存します（例: analysis.qmd）。

＜これ、最初は勝手にvisualモードになってるんですね。少し使いづらいな。私はSourceモードのほうがオススメです。＞

Visual モード

Source モード

＜Markdown記法でどのように書いているかもわかるし、他のエディタにコピペするときもSourceモードのほうがエラーがないので、こちらが好みですね。Visualモードだと若干動作が遅いこともあるので、注意が必要です。＞

2. YAMLヘッダーの設定

各Quartoドキュメントに適切なYAMLヘッダーを設定します。以下は、基本的な設定例です。

---
title: "My Analysis"
author: "Your Name"
date: "2024-06-15"
output: html_document
---Code language: JavaScript (javascript)

＜もう少しちゃんとやりたい場合はこちら ^[1]Shuntaro Sato’s website. Quartoを使ってHTML版の統計解析報告書を作るときの設定. https://shuntaro-sato.studio.site/blog/quarto_html が参考になります。以下は参考にした例です。＞

title: "Statistical Analysis Report"  # ドキュメントのタイトル
author: 
  - 著者名  # 著者名
date: "`r format(Sys.time(), '%Y/%m/%d, %H:%M')`"  # 現在の日付と時刻をフォーマット
format: 
  pdf:
    toc: true  # 目次を作成する
    toc-depth: 3  # 目次の階層の深さを設定する
    number-sections: true  # セクションに番号を付ける
  html:
    df-print: paged  # データフレームをページング表示する
    toc: true  # 目次を作成する
    toc-depth: 3  # 目次の階層の深さを設定する
    number-sections: true  # セクションに番号を付ける
    embed-resources: true  # すべてのリソース（画像、CSSなど）をHTMLファイルに埋め込む
    code-fold: true  # コードを隠し、クリックで開けるようにする
    code-line-numbers: true  # コードに行番号を表示する
execute: 
  echo: true  # コードをPDFやHTMLに含める
  warning: false  # 警告メッセージをPDFやHTMLに含めない
lang: "ja"  # ドキュメントの言語を日本語に設定する
pdf-engine: lualatex  # PDFの生成に使用するエンジンを指定する
documentclass: ltjsarticle  # LaTeXの文書クラスを指定するCode language: PHP (php)

3. 記載

Rチャンク内で必要なパッケージを読み込みます。pacmanパッケージを使用すると、パッケージのインストールと読み込みが簡単になります。

# pacmanパッケージをインストール（必要に応じて）
if (!require("pacman")) install.packages("pacman")

# 必要なパッケージを読み込む
pacman::p_load(tidyverse)

# CSVファイルの読み込み
data <- read_csv("path/to/your/data.csv")

# データの確認
head(data)Code language: PHP (php)

＜チャンクの出し方をまだ説明してないよ＞

おっと、失礼しました！Quartoでのチャンクの使い方について詳しく説明しますね。Quartoでは、コードチャンクを使ってRや他の言語のコードを実行できます。これにより、分析結果やグラフをドキュメント内に直接埋め込むことができます。

RStudioでは、簡単にチャンクを挿入するための便利なショートカットが用意されています。以下に、RStudioでのチャンク挿入の手順を説明します。

RStudioでのチャンク挿入方法

ショートカットを使う

カーソルの位置にチャンクを挿入する：
- RStudioのエディタで、チャンクを挿入したい位置にカーソルを置きます。
- Ctrl + Alt + I（Windows/Linux）または Cmd + Option + I（Mac）を押すと、新しいRチャンクが挿入されます。
メニューからチャンクを挿入する：
- RStudioのメニューから、Insert -> Rを選択することで、新しいRチャンクを挿入できます。
- 同様に、Insert -> Pythonなどを選択することで、他の言語のチャンクも挿入できます。

自動補完機能を利用する

RStudioでは、自動補完機能を利用してチャンクを挿入することも可能です。

チャンクの開始部分を入力する：
- エディタに“`{まで入力すると、RStudioが自動でチャンクの候補を表示します。
- 続けてrと入力してEnterを押すと、Rチャンクが自動的に挿入されます。
他の言語チャンクの挿入：
- 同様に、“`{python}“などと入力すると、自動でPythonチャンクが挿入されます。

ショートカット機能

＜Cmd + Option + I（Mac）は便利でよく使ってます。コメントアウト/インのCtrl+Shift+Cや、パイプ演算子 (|>) を渡す Ctrl+Shift+M は言わずもがなですね。キーボードショートカットはこちらの記事 ^[2]Qiita. 自分がよく使うRStudio キーボード・ショートカットを紹介. https://qiita.com/kazutan/items/f69ed2b606bfb8e938ca ^[3]ママ研究者の雑記帳. https://mom-neuroscience.com/r-multi-cursor/ がいいですよ。Ctrl+Shift+Alt+Mなんても知っておくと便利ですね。コードのインデントはCmd +Iで自動で調整してくれますよ。他にとっておきのキーボードショートカットオススメを３つだけ教えて下さい。＞

Rstuidoでインデント調整するときは Tab キーではなく、Windows「Control + i」; Mac「⌘ + i」が便利です。参考： https://t.co/XnVoG3paMj pic.twitter.com/YnjgYd9pn2
— Shoei (@shoei05) July 10, 2021

Cmd + Shift + Enter

ショートカット：Cmd + Shift + Enter（Mac）または Ctrl + Shift + Enter（Windows/Linux）
機能：R Markdownドキュメント内の現在のコードチャンクを実行します。

使い方

コードチャンク内にカーソルを置く：
- 実行したいコードチャンク内にカーソルを置きます。
ショートカットを押す：
- Cmd + Shift + Enter（Mac）または Ctrl + Shift + Enter（Windows/Linux）を押します。

これにより、選択したコードチャンクが実行され、結果がRStudioのコンソールやR Markdownドキュメント内に表示されます。

Shift + Enter

ショートカット：Shift + Enter（Mac/Windows/Linux）
機能：Rコンソールまたはスクリプトエディタで現在の行を実行し、次の行に移動します。

使い方

実行したい行にカーソルを置く：
- 実行したいRコードの行にカーソルを置きます。
ショートカットを押す：
- Shift + Enterを押します。

これにより、現在の行が実行され、カーソルが次の行に移動します。連続してShift + Enterを押すことで、次々と行を実行していくことができます。

＜そうですね。とても大事なところですね。＞

Zoteroとの連携

＜RのQuartoもZoteroと連携できるの？＞

はい、QuartoとZoteroは連携できます。これにより、Quartoドキュメント内でZoteroの文献データベースを簡単に引用することができます。QuartoでZoteroを使うためには、以下のステップを踏むと良いでしょう。

1. Zoteroのインストールと設定

まず、Zoteroをインストールし、必要な文献情報をZoteroに追加します。また、Zotero Connectorをブラウザにインストールしておくと、ウェブページから直接文献情報を取り込むことができます。

＜Zotero Connectorはこちら^[4]Zotero Connector. https://chromewebstore.google.com/detail/zotero-connector/ekhagklcjbdpajgpjgmbionohlpdbjgc?hl=ja ですね。私もよく使ってます。たまにZoteroが認識しないときは以下のやり方がありますよ。＞

調べ物をして興味のある pdf にヒットしたときの文献管理(Zotero)の私案。①デスクトップのZoteroアプリを開いておく、②pdf からタイトルをコピー、③Google Scholar の Chrome拡張(https://t.co/dv74BLlKdx )でタイトルを入力して検索、④引用 → RefMan をクリック、⑤Zotero に論文が取り込まれる
— Shoei (@shoei05) June 8, 2021

＜ZoteroとRstudioの連携は、以前、こちらにも記事を書いているので参考になればと思います。でも最近はこの連携機能はあまり使っていないですね。共著者に文書を共有するときに色々と手間が発生してしまうのが現状です。以下の方法でZoteroとの連携はできるので、リンク先のAPIキーはとりあえずは設定しなくても良いかも知れません。citation keyは知っておくと便利ではあるのですが。＞

Rstudio 1.4 で Zotero を利用する

2. Better BibTeXプラグインのインストール

ZoteroにBetter BibTeXプラグインをインストールします。これにより、ZoteroからBibTeX形式でのエクスポートが簡単に行えます。Better BibTeXは、Zoteroのアドオン管理からインストールできます。

3. Quartoドキュメントの準備

Quartoドキュメント内でZoteroの文献を引用するためには、次のように設定します。

YAMLヘッダーにBibTeXファイルを指定する:

---
title: "Your Document Title"
author: "Your Name"
bibliography: references.bib
---Code language: JavaScript (javascript)

Quartoドキュメントと同じディレクトリに、ZoteroからエクスポートしたBibTeXファイル（例: references.bib）を保存します。

＜プロジェクト管理自体は下記のテンプレートが役に立ちます。最近は、＞

mkdir {data,analysis,materials}

＜でまとめてしまうことも多いですね。＞

RstudioをGitHubとプロジェクトテンプレートで管理する

4. 文献の引用

Quartoドキュメント内で文献を引用する際には、以下のように引用キーを使用します。

テキスト内で引用する場合:

これは素晴らしい研究です [@author2020].Code language: CSS (css)

引用リストを生成する場合:

# References

5. Quartoのコンパイル

最後に、Quartoドキュメントをコンパイル（Render）します。これにより、指定したBibTeXファイルから文献リストが生成され、文中の引用も適切にリンクされます。

QuartoとZoteroを連携させることで、効率的に文献管理が行え、引用も簡単になります。特に大規模な文献リストを扱う際には、この方法が非常に便利です。さらに、Quartoの柔軟性とZoteroの強力な文献管理機能を組み合わせることで、よりプロフェッショナルなドキュメント作成が可能になります。

うまくいかなかったら？

＜うまく行かない場合はどうしたらいいですか？＞

新しいツールに挑戦するのは確かに大変なこともありますよね。でも、慣れるととても便利に感じることが多いと思います。もし途中で行き詰まったり、わからないことがあれば、いつでも気軽に尋ねてくださいね。あなたが次のステップに進むお手伝いができるのを楽しみにしています。頑張ってくださいね！またいつでもお待ちしています。

GPTs「Rはいいぞ」 pic.twitter.com/BtKHr7mxcq
— Shoei (@shoei05) June 5, 2024

References[+]

References
↑1	Shuntaro Sato’s website. Quartoを使ってHTML版の統計解析報告書を作るときの設定. https://shuntaro-sato.studio.site/blog/quarto_html
↑2	Qiita. 自分がよく使うRStudio キーボード・ショートカットを紹介. https://qiita.com/kazutan/items/f69ed2b606bfb8e938ca
↑3	ママ研究者の雑記帳. https://mom-neuroscience.com/r-multi-cursor/
↑4	Zotero Connector. https://chromewebstore.google.com/detail/zotero-connector/ekhagklcjbdpajgpjgmbionohlpdbjgc?hl=ja