Edited at
RDay 25

Visual Studio Codeを使ったR言語開発環境の利用ガイド


はじめに

Visual Studio Code(以下VSCode)でR Studioのような環境vscode-rを開発しました.

本記事はより快適にR言語をVS Codeで利用していただくために以下のトピックを紹介します.

3/7 開発を再開しました.補完機能を開発したので追記


想定読者


  • RユーザーでVS Codeを利用し始めた人

  • R以外の言語も同一プロジェクトで管理したい人

  • 開発環境を一つに統一したい人


他開発環境との比較

他のR開発環境で代表的なものは以下となります.

VSCode版を利用するメリット,デメリットは以下の通りとなります.

他の開発環境の利用歴が短いためVS Codeよりの内容となっています.


メリット


  • 他の開発言語ファイルと並行して利用可能

  • シンタックスハイライトが豊富

  • Windows, Mac, Linuxで利用可能

  • VS Code自体が成長中(日本語にも対応)

  • 日本語でのバグ報告,リクエスト,質問歓迎(https://github.com/Ikuyadeu/vscode-R/issues)


デメリット

R以外の開発言語を利用しない,パッケージ管理が必須な方はR Studioのほうをおすすめします.


初めての実行

実行環境の導入については別の利用者様が記事を書いてくださった為そちらをご参照ください.

読むのがめんどうな方は

* VS Code

* R

* R-LSP

* vscode-r

を取得してwindows版のみsetting.jsonでRのパスを定義してもらえば十分です.

実行はR Studioと同じく


  • 現在の行または選択行を実行: Ctrl + Enter(Macは+Enter)

  • ソースコード全体を実行: Ctrl + Shift + Enter(Macは + Shift + Enter)またはソースコード上の
    ボタン

で可能となっています.


機能ガイド

上の初めての実行で書かれてない設定やコマンドについて紹介

Rに限らず設定はsetting.jsonから変更できます.(詳しくはこちら)

コマンドはF1キー(Macのバージョンによってはfn+F1)から呼び出せます.


lintr

lintrはコードを綺麗にするためのツールです.

初めての実行でも紹介されていますがさらに変更するための設定の紹介です.

用途に合わせてご利用ください.

* r.lintr.enabled -> false: lintrを無効にします

* r.lintr.ispackage -> true: プロジェクト全体のコードをチェックします.

LSPでサポートされているので必要な方はLSPのインストールをしてください


プレビュー

R Studioのようにデータの状況を見ることができます.


  • データフレームの内容を閲覧: データフレーム名を選択 -> F1 -> R: Preview Dataframe



  • 環境変数の閲覧: F1 -> R: Preview Environment


下のようなソースコードを読み込んだ場合


test.r

# © Microsoft. All rights reserved.

#' Add together two numbers.
#'
#' @param x A number.
#' @param y A number.
#' @return The sum of \code{x} and \code{y}.
#' @examples
#' add(1, 1)
#' add(10, 1)
add <- function(x, y) {
x + y
}

hello <- rnorm(100)

#region

print(add(1, -2))
print(add(1.0e10, 2.0e10))

#endregion

print(paste("one", NULL))
print(paste(NA, 'two'))

print(paste("multi-
line"
,
'multi-
line'
))


こうなります(利用テーマは同じく開発中のlucario).


Git

R Studioなどの開発環境から移行した場合はF1 -> R: Create gitignoreで設定ファイルを無効にできます.


今後のアップデート予定


  • プロットの出力調整

補完機能についてはSublime, Atom, VS Codeでの共通機能となる予定のためお好きなエディタをご利用ください.


まとめ

学業の都合で開発は遅くなっていますが,機能リクエストなど気軽にコメントいただけると幸いです.(https://github.com/Ikuyadeu/vscode-R/issues).

現在コントリビュータ2人を加えてゆっくり開発中ですが,まだ手が足りていない状況ですので,興味があればぜひご参加ください.(特にWindows環境,日本語環境のバグ)