井出草平の研究ノート

トップ > R > VSCodeのR Extensionのオプションの設定

VSCodeのR Extensionのオプションの設定

R 計量 VSCode

code.visualstudio.com

R: Always Use Active Terminal

  • 説明:
    この設定を有効にすると、新しいRターミナルを作成せずに、すでに開いているターミナルを再利用する。これにより、ターミナルが複数開くことを防ぐことができる。

  • 推奨設定:
    通常は有効にしておく（true）のが望ましい。ただし、複数のセッションを同時に使用したい場合は無効にすることも可能である。

R: Bracketed Paste

  • 説明:
    ターミナルにコードを送信する際に「Bracketed Paste Mode」を有効にする。このモードは、コードを安全に貼り付けるのに役立つ。特に radian コンソールを使用する場合に推奨される。

  • 推奨設定:
    有効にする（true）ことで、ターミナルへのコード貼り付け時に発生する問題を防ぐことができる。

R: Help Panel: Cache Index Files

  • 説明:
    ヘルプパネルでパースされたヘルプインデックスを、セッション間でどこに保存するかを設定する。

  • 選択肢:

    1. None（default）: キャッシュを保存しない（デフォルト設定）。
    2. Workspace: 現在の作業スペース（プロジェクト）内にキャッシュを保存する。
    3. Global: グローバルな設定としてキャッシュを保存し、全プロジェクトで利用可能にする。

  • 推奨設定:

    • ヘルプ読み込みの高速化を求める場合、Workspace または Global を選択するのがよい。
    • キャッシュが不要で、毎回最新の情報を読み込みたい場合は、None または Do not store anything を選択するとよい。

R: Help Panel: Click Code Examples

  • 説明:

    ヘルプページ内のコード例をクリックしたときの動作を設定する。

    • Click: コードをコピーする。
    • Ctrl+Click: コードをターミナルで直接実行する。
    • Shift+Click: コードを無視する（クリックしても何も起きない）。

  • 推奨設定:

    デフォルト設定が実用的であるが、コード例をクリックして即座に実行したい場合は Ctrl+Click を覚えておくと便利である。

R: Help Panel: Enable Hover Links

  • 説明:

    VSCodeエディター上で関数やオブジェクトにマウスをホバーした際に、対応するヘルプリンクを表示する。

  • 推奨設定:

    有効にする（true）ことで、ヘルプ情報へのアクセスが簡単になり、効率的に作業を進めることができる。

R: Help Panel: Preview Local Packages

  • 説明:

    ヘルプパネルでローカルパッケージのヘルプページをプレビューするためのローカルディレクトリを指定する。空のリスト（[]）を設定することで、この機能を無効化する。

  • 推奨設定:

    ローカルパッケージのヘルプを頻繁に参照する場合は、適切なディレクトリを追加する。不要な場合は無効化（[]）する。

R: Lib Paths

  • 説明:

    Rのバックグラウンドプロセス（言語サーバー、ヘルプサーバーなど）を起動する際に使用する追加のライブラリパスを指定する。このパスは、プロセス起動時に .libPaths() に追加される。renv を使用しているプロジェクトで役立つ。

  • 推奨設定:

    特定のパッケージが必要な場合は、該当パスを追加する。それ以外の場合はデフォルトのままで問題ない。

R: Live Share: Defaults: Command Forward

  • 説明:

    Live Shareセッションでゲストにコマンドを転送するかどうかを指定するデフォルト値を設定する。

  • 推奨設定:

    セッション中にゲストがコマンドを実行する必要がある場合に有効にする。それ以外ではオフ（false）にしておくとよい。

R: Live Share: Defaults: Share Browser

  • 説明:

    Live ShareセッションでRのブラウザーポート（プロットやシャイニーページなど）を自動的にゲストと共有するかを指定するデフォルト値を設定する。

  • 推奨設定:

    ゲストにプロットやアプリケーションを共有する場合は有効化（true）する。共有の必要がない場合は無効化（false）でよい。

R: Live Share: Defaults: Share Workspace

  • 説明:

    Live ShareセッションでRのワークスペース（現在のオブジェクトや変数）をゲストと共有するかどうかを指定するデフォルト値を設定する。

  • 推奨設定:

    ゲストにワークスペースの内容を見せる必要がある場合は有効化する。セッション中のデータを保護したい場合は無効化する。

R: Lsp: Args

  • 説明:

    R Language Server を起動するときに使用するコマンドライン引数を指定する。必要なオプションがあれば、ここに追加する。

  • 推奨設定:

    特定の引数を使用する必要がない場合は、デフォルトのまま空欄で問題ない。

R: Lsp: Debug

  • 説明:

    R Language Server のデバッグモードを有効にする。この設定を有効にすると、詳細なログが生成される。

  • 推奨設定:

    問題が発生した際にデバッグのため有効にする。それ以外では無効のままでよい。

R: Lsp: Diagnostics

  • 説明:

    Rコードの診断機能（文法エラーや警告の検出など）を有効にする。これにより、コード内の問題がリアルタイムで指摘される。

  • 推奨設定:

    有効（true）にしておくことで、開発効率が向上する。

R: Lsp: Enabled

  • 説明:

    R Language Server を有効化する。この設定を有効にすると、コード補完、シグネチャヘルプ、定義の表示、診断機能などのコード解析機能が使用可能になる。

  • 推奨設定:

    有効（true）にしておくことが基本。

R: Lsp: Lang

  • 説明:

    デフォルトの LANG 環境変数を上書きする。この設定を使うことで、特定のロケール設定を指定できる。

  • 推奨設定:

    特定のロケールを必要としない場合は空欄のままで問題ない。

R: Lsp: Multi Server

  • 説明:

    マルチルートワークスペース（複数のプロジェクトを同時に開いている状態）で複数の R Language Server を使用するかどうかを設定する。無効にすると、単一のサーバーがすべてのワークスペースを処理する。

  • 推奨設定:

    マルチルートワークスペースを利用する場合は有効（true）にする。それ以外では無効でも問題ない。

R: Lsp: Prompt To Install

  • 説明:

    R Language Server がインストールされていない場合に、インストールを促すプロンプトを表示する設定である。

  • 推奨設定:

    有効（true）にしておくことで、必要な場合にすぐにインストールできるため便利である。

R: Lsp: Use_stdio

  • 説明:

    TCP の代わりに STDIO 接続を使用する。これは主に Unix/macOS ユーザー向けの設定である。

  • 推奨設定:

    Unix/macOS ユーザーが TCP に問題がある場合に有効にする。それ以外では無効（false）のままで問題ない。

R: Plot: Custom Style Overwrites

  • 説明:

    カスタム CSS ファイルのパスを指定する。R > Plot > Defaults: Color Theme が vscode に設定されている場合に、このCSSがデフォルトのスタイルを上書きする。

  • 推奨設定:

    デフォルトの見た目を変更したい場合に、カスタムCSSのパスを指定する。それ以外では空欄でよい。

R: Plot > Defaults: Color Theme

  • 説明:

    httpgd プロットビューワーのカラーテーマを選択する。

    • 選択肢:

      • original: デフォルトのテーマ。
      • vscode: Visual Studio Code のテーマに合わせた表示。

  • 推奨設定:

    VSCodeの配色に合わせたい場合は vscode を選択する。特にこだわりがなければ original を使用する。

R: Plot > Defaults: Full Window Mode

  • 説明:

    httpgd プロットビューワーを起動する際に、全画面モードを使用するかどうかを設定する。

  • 推奨設定:

    プロットを大きな画面で見たい場合に有効（true）にする。それ以外では無効のままでよい。

R: Plot > Defaults: Plot Preview Layout

  • 説明:

    プロットを複数行表示する場合のレイアウトを設定する。

    • 選択肢:
      • multirow: 複数行で表示。
      • その他のカスタムレイアウトも可能。

  • 推奨設定:

    複数のプロットを管理しやすくしたい場合は multirow を使用する。

R: Plot: Dev Args

  • 説明:

    PNGデバイスでグラフィックを再生する際の引数を指定する。この設定はVSCode内でプロットを表示するために使用される。設定はRオプション vsc.dev.args に変更を加える。R > Plot: Use Httpgd が false に設定されている必要がある。

  • 項目例:

    • width: プロット画像の幅（単位: ピクセル）。
    • height: プロット画像の高さ（単位: ピクセル）。

  • 推奨設定:

    デフォルト（例: width = 800, height = 1200）で十分な場合が多い。特定の用途で画像サイズを調整したい場合に変更する。

R: Plot > Timing: Refresh Interval

  • 説明:

    プロットの更新間隔をミリ秒単位で指定する。プロットが連続して更新される場合の待ち時間を設定する。

  • デフォルト値: 10ms

  • 推奨設定:

    通常はデフォルトのままで問題ない。頻繁な更新が不要な場合は値を大きくするとよい。

R: Plot > Timing: Resize Interval

  • 説明:

    プロットのリサイズ間隔をミリ秒単位で指定する。リサイズの頻度を制御する。

  • デフォルト値: 100ms

  • 推奨設定:

    デフォルトのままで十分であるが、リサイズが頻繁に発生する場合は値を調整して負荷を軽減する。

R: Plot: Use Httpgd

  • 説明:

    標準のVSCode-Rプロットビューアの代わりに、httpgd を使用するかどうかを設定する。この設定はRオプション vsc.use_httpgd を変更する。httpgd パッケージのバージョン1.2.0以上が必要である。

  • 推奨設定:

    httpgd をインストールしている場合、有効（true）にすることでインタラクティブなプロット表示が可能になる。httpgd を使用しない場合は無効（false）にする。

R: Remove Leading Comments

  • 説明:

    コードをターミナルに送信する際に、先頭のコメント行を削除する設定である。コメント行が多いスクリプトで、不要なコメントをターミナルに送信したくない場合に便利である。

  • 推奨設定:

    必要に応じて有効化する。コメントを残したい場合は無効化（false）にしておく。

R > Rmarkdown: Chunk Background Color

  • 説明:

    RMarkdownのコードチャンクの背景色をRGBAまたはRGB値で指定する。設定を空欄にすると、デフォルトのエディタ背景色が使用される。

  • 値の例:

    • rgba(128, 128, 128, 0.1): 薄い灰色の半透明。
    • rgba(255, 165, 0, 0.1): 薄いオレンジ色の半透明。

  • 注意:

    設定を変更した後に、VSCodeをリロードする必要がある。

  • 推奨設定:

    エディタの視認性や好みに合わせて調整する。チャンクを目立たせたい場合は、適度な背景色を選ぶ。

R > Rmarkdown: Code Lens Commands

  • 説明:

    RMarkdownでのCodeLensコマンド（各コードチャンクの先頭に表示される「Run Chunk」などのボタン）をカスタマイズする。

  • カスタマイズ可能なコマンド:

    • r.runCurrentChunk: 現在のチャンクを実行する。
    • r.runAboveChunks: 現在のチャンクまでの全てのチャンクを実行する。

  • 推奨設定:

    デフォルトで十分な場合が多いが、特定の順序や機能を追加したい場合にカスタマイズする。

R > Rmarkdown > Knit: Command

  • 説明:

    R Markdownファイル（.Rmd）をKnit（レンダリング）する際に使用されるデフォルトのコマンドを指定する。デフォルトでは rmarkdown::render が使用される。

  • 推奨設定:

    特別な要件がない限り、デフォルトの rmarkdown::render を使用する。

R > Rmarkdown > Knit > Defaults: Knit Working Directory

  • 説明:

    R Markdownのチャンクが実行される際の作業ディレクトリを指定する。デフォルトではドキュメントのディレクトリが使用される。

  • オプション:

  • 推奨設定:

    通常はデフォルトの document directory で問題ないが、特定の作業ディレクトリを使用したい場合にカスタマイズする。

R > Rmarkdown > Knit: Focus Output Channel

  • 説明:

    R MarkdownをKnitする際に、出力チャンネル（ターミナルや出力ウィンドウ）にフォーカスするかどうかを設定する。この設定には、バックグラウンドプロセスの使用（Use Background Process）が有効である必要がある。

  • 推奨設定:

    フォーカスを必要とする場合にチェックを入れる（true）。作業中にフォーカスを移動させたくない場合は無効にする。

R > Rmarkdown > Knit: Open Output File

  • 説明:

    Knitプロセスが完了した後に、生成された出力ファイル（HTMLやPDFなど）を自動的に開くかどうかを設定する。この設定にもバックグラウンドプロセスの使用が必要。

  • 推奨設定:

    出力ファイルをすぐに確認したい場合は有効化（true）する。それ以外の場合は無効のままでよい。

R > Rmarkdown > Knit: Use Background Process

  • 説明:

    R MarkdownのKnit処理をバックグラウンドプロセスで実行するかどうかを設定する。バックグラウンドプロセスでは、進行状況バーやエラー検出などの追加機能が利用可能になる。

  • 推奨設定:

    有効化（true）することでKnitの操作性が向上する。特別な理由がない限り、この設定を有効にしておくのが望ましい。

R > Rmarkdown > Preview: Auto Refresh

  • 説明:

    ファイルが更新されるたびに、R Markdownのプレビューを自動的にリフレッシュする設定である。

  • 推奨設定:

    有効化（true）することで、作業中のR Markdownファイルが常に最新の状態でプレビューされるため便利である。

R > Rmarkdown > Preview: Zoom

  • 説明:

    R Markdownプレビューのズームレベルを制御する。数値を設定することで、プレビューの拡大縮小を調整できる。

  • 推奨設定:

    デフォルト値（1）で問題ないが、プレビューが小さく見える場合は値を大きく（例: 1.5）、逆に大きすぎる場合は小さく（例: 0.8）調整する。

R > Rpath: Linux / Mac / Windows

  • 説明:

    Rのバックグラウンドプロセスを起動する際に使用するR実行ファイルのパスを指定する。ここで指定するのは「標準的なR（vanilla）」である必要があり、radianなどのカスタムシェルは利用不可である。

  • 設定例（Windowsの場合）:

  "C:\\Program Files\\R\\R-4.4.1\\bin\\R.exe"

このように書かない

  "C:\Program Files\R\R-4.4.1\bin\R.exe"

Linux: "/usr/bin/R" 　

Mac "/Library/Frameworks/R.framework/Resources/bin/R"

  • 推奨設定:

    OSに合わせて正しいRのパスを指定する必要がある。Rのインストールディレクトリを確認して設定する。

R > Rterm: Linux / Mac / Windows

  • 説明:

    インタラクティブなターミナルで使用するRのパスを指定する。radian や標準のR実行ファイルを指定可能である。

  • 設定例（Windowsの場合）:

  "C:\\Program Files\\R\\R-4.4.1\\bin\\R.exe"

  • 推奨設定:

    使用している環境に合わせて、正しいRのパスを設定する。

R > Rterm: Option

  • 説明:

    Rターミナルの起動時に使用するコマンドラインオプションを設定する。

  • デフォルト値:

    • --no-save: セッション終了時に作業スペースを保存しない。
    • --no-restore: 起動時に作業スペースを復元しない。

  • 推奨設定:

    デフォルトのままで問題ないが、作業スペースの復元や保存を有効にしたい場合はオプションを変更する。

R > Rterm Send Delay

  • 説明:

    コードをターミナルに送信する際の遅延をミリ秒単位で指定する。遅延を設定することでターミナルの処理安定性を向上させる場合がある。

  • 推奨設定:

    デフォルト値（8ms）で問題ないが、遅延が不要な場合は値を小さくする。

R > Session > Data: Page Size

  • 説明:

    データビューアで1ページに表示する行数の最大値を指定する。値が0の場合、ページネーションが無効になる。

  • 推奨設定:

    デフォルトの500が一般的に適切だが、より多くのデータを1ページで表示したい場合は値を大きくする。

R > Session > Data: Row Limit

  • 説明:

    データビューアに表示する行数の最大値を設定する。値が0の場合、制限が無効化される。

  • 推奨設定:

    必要な場合のみ値を設定し、通常はデフォルト（0）のままにする。

R > Session > Emulate RStudio API

  • 説明:

    RStudioのAPIをエミュレートし、rstudioapiを使用したアドインや関数をサポートする設定。

  • 推奨設定:

    有効化（チェックを入れる）することで、RStudio依存のコードやアドインを使用可能にする。

R > Session > Level Of Object Detail

  • 説明:

    オブジェクトをホバーした際や補完時に表示される詳細情報のレベルを指定する。

  • 推奨設定:

    デフォルトのMinimalで十分だが、詳細な情報が必要な場合はModerateやDetailedを選択する。

R > Session > Object Length Limit

  • 説明:

    ワークスペースビューアや補完機能で表示されるオブジェクトの最大長を制限する設定。大きなオブジェクトが原因で遅延する場合に効果的。

  • 推奨設定:

    デフォルトの2000を維持し、パフォーマンス問題がある場合は値を減らす。

R > Session > Object Timeout

  • 説明:

    グローバル環境内の単一オブジェクト情報取得のタイムアウトをミリ秒単位で指定する。

  • 推奨設定:

    デフォルトの50msを維持する。パフォーマンス問題がある場合は値を小さくする。

R > Session > Use Web Server

  • 説明:

    拡張機能でセッションリクエストを処理するためにウェブサーバーを使用する実験的な設定。httpgdパッケージが必要。

  • 推奨設定:

    必要に応じて有効化（チェックを入れる）。

R > Session > Viewers: View Column

  • 説明:

    R関連のWebビュー（プロット、ブラウザ、ビューアなど）をどの列に表示するかを指定する。

  • 推奨設定:

    デフォルト設定（例：plot: Two）を維持する。

R > Session > Watch Global Environment

  • 説明:

    グローバル環境を監視し、補完やワークスペースビューアの情報を提供する設定。

  • 推奨設定:

    有効化（チェックを入れる）することで作業効率を向上させる。

R > Session Watcher

  • 説明:

    セッションウォッチャーを有効化する設定。ワークスペースビューアなどの多くの機能に必要となる。

  • 推奨設定:

    有効化（チェックを入れる）し、VSCodeを再起動して反映させる。

R > Source: Echo

  • 説明:

    ファイルを実行する際、コードをターミナルに出力するかどうかを設定する。

  • 推奨設定:

    必要に応じて有効化する。通常は無効のままで問題ない。

R > Source: Encoding

  • 説明:

    ファイルをRで実行する際の文字エンコーディングを指定する。

  • 推奨設定:

    デフォルトのUTF-8を使用する。

R > Source: Focus

  • 説明:

    ターミナルにコードを送信した後、どこにフォーカスを移すかを指定する。

  • 推奨設定:

    デフォルトのeditorを維持する。

R > Use Renv Lib Path

  • 説明:

    renvライブラリパスを使用してバックグラウンドプロセスを起動する設定。

  • 推奨設定:

    必要な場合のみ有効化する。

R > Workspace Viewer: Clear Prompt

  • 説明:

    ワークスペースをクリアする際に確認プロンプトを表示する設定。

  • 推奨設定:

    有効化（チェックを入れる）して、誤操作を防ぐ。

R > Workspace Viewer: Remove Hidden Items

  • 説明:

    ワークスペースをクリアする際に隠しアイテムを削除する設定。

  • 推奨設定:

    必要に応じて有効化する。

R > Workspace Viewer: Show Object Size

  • 説明:

    ワークスペースビューア内でオブジェクトをホバーした際にサイズを表示する設定。

  • 推奨設定:

    必要に応じて有効化する。通常は無効のままで問題ない。