Quartoのコードブロック内の関数にドキュメントリンクをつける方法

r
code-linkオプションでQuartoのコードブロック内の関数にドキュメントリンクをつける方法についてのメモです
Published

2026-01-28

Modified

2026-01-28

Quartoのコードブロック内で使用されている関数にドキュメントリンクを自動的に追加する方法についてのメモです。 code-linkオプションを使用すると、コードブロック内の関数に対応するドキュメントへのリンクを追加できます。

_quarto.ymlファイルに以下のように設定を追加します。

_quarto.yml
format:
  html:
    code-link: true

これにより、HTML出力時にコードブロック内の関数名がリンク付きで表示されるようになります。

使用例

インラインコードやコードブロック内で関数を使用すると、リンクが自動的に追加されます。例えば、以下のようにRコードブロックを記述します。

  • 例文： このようにunique()関数を使用すると、ベクトルの重複を取り除くことができます。

また、コードブロック内でも同様にリンクが追加されます。

x <- c("apple", "banana", "apple", "orange", "banana")
unique_x <- unique(x)
print(unique_x)
[1] "apple"  "banana" "orange"

それぞれの関数にマウスを合わせると、リンクがついていることを示す下線が表示され、クリックすると対応するドキュメントページに移動します。 今回の例だと、c()、unique()、print()関数にリンクが追加されているのではないでしょうか。

注意点

  • code-linkオプションはknitrエンジンでのみサポートされています。他のエンジンを使用している場合は、リンクが生成されないようです (内部でdownlitパッケージを使用しているため)。簡単に言うと、Rコードブロックでのみ機能します。
  • code-line-numbersオプションやcode-annotationsオプションとは併用ができないようです。これらのオプションを有効にしている場合、code-linkオプションは無視されます。
Tip

code-line-numbersオプションは、コードブロックに行番号を追加するためのオプションです。

code-annotationsオプションは、コードブロックに注釈を追加するためのオプションです。

参考