RStudio® Workbench

Code Workspaces では、Foundry で RStudio® Workbench ↗ を使用できます。Code Workspaces の RStudio® Workbench は、次の機能をサポートしています。

• Palantir R SDK ↗ を使用した表形式データセットの読み取りと書き込み。
• 非構造化データセットからのファイルのダウンロード、または非構造化データセットへのファイルのアップロード。
• CRAN、Posit™ library Manager、Bioconductor からの R ライブラリのインポート。
• Shiny® アプリケーションの公開。
• R トランスフォームの公開。

Code Workspaces は現在、R アプリケーション向けに Shiny® ↗ をサポートしています。ユーザーは、Foundry のバージョン管理、ブランチ、データガバナンス機能が組み込まれた Code Workspaces で、アプリケーションを直接作成できます。

Code Workspace のアプリケーションはブランチをサポートしています。新しい Workspace ブランチを作成した場合、新しいアプリケーションを公開するか変更を同期すると、そのブランチにアプリケーションの新しいバージョンが公開されます。これにより、ユーザーに公開する前にアプリケーションをプレビューできます。master ブランチに公開するには、このブランチを master にマージするだけです。

Shiny®

Code Workspaces では、Shiny® アプリケーションを作成し、RStudio® UI から直接プレビューできます。

Code Workspaces でアプリケーションを公開するを選択し、ファイルとプロジェクトで新しいアプリケーションの場所を選択して、新しい Shiny® の app.R ファイルを自動作成するディレクトリの名前を、リポジトリのルート /home/user/repo からの相対パスで入力します。この項目を空欄にすると、リポジトリのルートにアプリケーションが作成されます。デフォルトでは、アプリケーションの設定は RStudio® ワークスペースの設定と一致し、詳細設定は任意です。

新しい Shiny® アプリケーションを登録し、元となるコードリポジトリにコードを同期するには、公開と同期を選択します。CI チェックと公開が完了したら、アプリケーションパネルのリンクを選択して、公開済みのアプリケーションを表示できます。

Shiny® アプリケーションをローカルで開発するには、次の手順に従います。

1. RStudio® で app.R を開きます。
2. アプリを実行を選択します。新しいウィンドウにアプリケーションのプレビューが表示されます。

Shiny® アプリケーションを自動的に再接続するように設定する

デフォルトでは、たとえば15秒を超えるネットワーク障害が発生して WebSocket 接続が閉じられると、Shiny はグレーアウトします。ネットワーク接続が復旧したときにアプリケーションが回復できるように、server 関数を更新して session$allowReconnect("force") を設定することを推奨します。

Copied!
1
2
3
4
server <- function(input, output, session) {
  # 入力の変更を処理します
  session$allowReconnect("force")
}

これにより、ネットワークが再び利用可能になると、フロントエンドが新しい WebSocket 接続を開始し、UI で最後に設定された入力情報を送信します。

R トランスフォーム

Code Workspaces で作成した R スクリプトは、Code Workspaces の出力データセットのトランスフォームとして登録できます。

出力データセットのトランスフォームを登録するには、次の手順に従います。

1. データパネルで、データセットの横にある青い Build アイコンを選択します。

2. インターフェースに沿ってトランスフォームを設定します。Code Workspaces は、出力データセットの生成に使用する R スクリプトと、追加された入力を推測します。

3. 同期して実行を選択すると、トランスフォームの設定が保存され、出力データセットにトランスフォームと Job Spec を公開するための CI チェックが開始されます。

CI チェックが完了すると、トランスフォームをビルドする準備が整います。その後、ほかの Foundry のデータ統合ツールを使用して、トランスフォームと、それが属するデータパイプラインを管理できます。

Copied!
1
renv::install(c("dplyr", "tidyr"))

R トランスフォームについて詳しくはこちら。

RStudio® および Shiny® は Posit™ の商標です。

ここで言及する第三者の商標（ロゴおよびアイコンを含む）は、すべてそれぞれの所有者に帰属します。提携や推奨を示唆するものではありません。

Markdown レポート

RStudio® ワークスペースで作成した R Markdown または Quarto ファイルは、レポートとしてほかの Palantir プラットフォームのユーザーと共有できます。レポートは、トランスフォームを使用して Markdown ファイルからビルドされるデータセットで、Quarto ↗ で Markdown ファイルを表示用に変換して生成した HTML を含みます。

レポートはトランスフォームを使用してビルドされるため、スケジュールを使用して、Markdown ファイルの最新の変更に基づいて自動的に更新するように設定できます。これにより、分析と可視化が最新の状態に保たれ、Palantir プラットフォームのほかの部分と統合された、再現可能でカスタマイズ可能なワークフローでビルドされます。

RStudio® ワークスペースからレポートを公開する

次の手順で、RStudio® ワークスペースから Markdown レポートを公開できます。

1. レポートの作成に使用する Markdown ファイル（.Rmd または .qmd）を作成します。この Markdown ファイルは、データサイドパネルを使用してワークスペースに追加した Foundry データセットから読み取ることができます。
2. アプリケーションサイドパネルを開き、Reports タブを選択します。
3. 追加を選択して、レポート設定ダイアログを開きます。
4. 名前を入力し、場所を指定します。これにより、レポートを含むデータセットの保存先が決まります。
5. レポートのビルド元となる Markdown ファイルを選択します。Markdown が Foundry データセットから読み取る場合は、それらのデータセットをレポートの入力として追加します。入力と出力を自動設定するを選択すると、Markdown ファイルが自動的にパースされ、検出されたデータセットがフォームに入力されます。
6. 作成するを選択します。指定した場所にデータセットが作成されます。その後、レポートをビルドするトランスフォームが実行されます。完了までに数分かかる場合があります。
7. レポートがビルドされたら、アプリケーションサイドパネルでレポート名を選択して、新規タブでレポートを開きます。このリンクはほかのユーザーと共有できます。

既存のレポートを編集または削除するには、レポートカードの右側にある ... を選択します。レポートの編集または削除の選択肢と、レポートへのリンクをコピーする選択肢を含むメニューが開きます。

以前のレポートバージョンを表示する

レポートは完全なバージョン履歴をサポートしています。以前のバージョンのレポートを表示するには、アプリケーションサイドパネルでレポートカードを展開するか、新規タブでレポートを表示しているときにページヘッダーのバージョンセレクターを使用します。

レポートのバージョンを選択すると、レポートの共有に使用するリンクが更新されます。これにより、元の Markdown が変更されても更新されない、特定の過去のバージョンのレポートを共有できます。

デフォルトではレポートの最新バージョンが選択されるため、レポートの閲覧者には最新の変更が自動的に表示されます。

RStudio® の管理された conda 環境

RStudio® の conda 環境は、管理された環境を使用することで、RStudio® ワークスペース、Shiny アプリケーション、トランスフォーム、モデル出力全体で一貫して復元できます。管理された環境は Code Workspace のワークフロー全体で一貫しているため、ワークスペースの再起動、Shiny アプリケーションの起動、RStudio® トランスフォームの実行のたびに、同じ renv::install コマンドを再実行する必要がなくなります。

管理された環境には、Maestro による CRAN ライブラリ管理も含まれます。Maestro は、conda および CRAN と連携してライブラリのインストールを処理し、管理された環境を維持する Foundry のライブラリ管理ツールです。新しくインストールされた CRAN ライブラリは環境ファイルで追跡され、同じワークフロー全体で一貫して復元されるため、環境の再現性が向上します。管理された conda 環境および CRAN 環境を有効にするには、以下のはじめにセクションを参照してください。

ライブラリのインストールコマンドを Maestro に移行するには、以下の conda または CRAN の手順を参照してください。管理された環境では、作業環境にインストールされたライブラリが以下のファイルで追跡されるため、ワークフロー全体で環境を元の状態に復元できます。

1. /home/user/repo/.envs/maestro/meta.yaml：環境のマニフェストと呼ばれ、環境で要求されたライブラリとバージョンが含まれます。
2. /home/user/repo/.envs/maestro/hawk.lock：環境のロックファイルと呼ばれ、マニフェストで指定された制約から解決された、環境の解決済みライブラリとバージョンが含まれます。hawk.lock ファイルは、非推奨となった conda.lock に代わるものです。

conda 環境で新しいコードを同期すると、上記のファイルも同期されます。次のセッションを起動すると、復元されたコードに maestro ファイルが含まれ、環境が再作成されます。

管理された環境は /home/user/envs/default フォルダーにインストールされます。この環境は、以下のいずれのイベントよりも前に復元されます。

• RStudio® ワークスペースの起動
• ワークスペースから作成された Shiny アプリケーションの起動
• ワークスペースから作成された RStudio® トランスフォームの実行
• Markdown レポートのレンダリング

はじめに

1. 管理された環境を有効にする

RStudio® ワークスペースで管理された環境を有効にするには、左サイドバーからワークスペースの設定に移動し、高度な機能にある管理された Conda 環境をオンにします。デフォルトですでにオンになっている場合もあります。

次に、ワークスペースを再起動します。

RStudio® ワークスペースで Maestro による CRAN ライブラリ管理を有効にするには、左サイドバーからワークスペースの設定に移動し、試験的な機能にある管理された CRAN 環境をオンにします。このオプションはデフォルトですでに有効になっている場合もあります。

次に、ワークスペースを再起動します。

2. 管理された環境を更新する

以下の手順に沿って、管理された環境を更新し、新しいライブラリを管理します。

Maestro で conda ライブラリを管理する（推奨）

CRAN ではなく conda で R ライブラリをインストールすると、ワークスペースの起動時間を大幅に短縮できます。

• ライブラリパネルを使用してインストールする：

  • 標準ライブラリの場合：r- 接頭辞を付けたライブラリ名（たとえば、ggplot2 ではなく r-ggplot2）を検索してインストールします。
  • Bioconductor ライブラリの場合：bioconductor- 接頭辞を付けた小文字のライブラリ名（たとえば、bioconductor-genomeinfodb）を検索してインストールします。

• ターミナルを使用してインストールする： ライブラリの最新バージョンをインストールするには、ターミナルで以下のコマンドを実行します。

  Copied!
  1
  maestro env conda install <library_name>

  特定のバージョンをインストールするには、以下のコマンドを実行します。

  Copied!
  1
  maestro env conda install <library_name>==<library_version>

• ターミナルを使用してアンインストールする： ライブラリをアンインストールするには、ターミナルで以下のコマンドを実行します。

  Copied!
  1
  maestro env uninstall --conda-dependencies <library_names>

Maestro で CRAN ライブラリを管理する

• ライブラリパネルを使用してインストールする：

  • 標準ライブラリの場合：ライブラリ名（たとえば、ggplot2）を検索してインストールします。
  • Bioconductor ライブラリの場合：先頭を大文字にした形式のライブラリ名（たとえば、GenomeInfoDb）を検索してインストールします。

• ターミナルを使用してインストールする： ライブラリの最新バージョンをインストールするには、ターミナルで以下のコマンドを実行します。

  Copied!
  1
  maestro env cran install <library_name>

  特定のバージョンをインストールするには、以下のコマンドを実行します。

  Copied!
  1
  maestro env cran install <library_name>@<library_version>

• ターミナルを使用してアンインストールする： ライブラリをアンインストールするには、ターミナルで以下のコマンドを実行します。

  Copied!
  1
  maestro env uninstall --cran-dependencies <library_names>

3. 管理された環境に現在インストールされているライブラリを表示する

インストールされた conda ライブラリは、左サイドバーのライブラリタブに表示されます。

RStudio® インターフェースで meta.yaml ファイルと hawk.lock ファイルを表示することもできます。

4. 管理された環境を hawk.lock ファイルの変更と同期する

新しいブランチをチェックアウトしたり、git の新しい変更をプルしたりすると、hawk.lock ファイルの内容が変わる場合があります。

管理された環境を同期するには、ワークスペースのターミナルで以下のコマンドを実行します。

Copied!
1
maestro env install

maestro は、管理された環境を更新するコマンドラインインターフェースです。上記のコマンドは、マニフェストからロックファイルを再解決し、環境を /home/user/envs/default フォルダーにインストールします。

5. 環境ファイルの git の競合を解決する

管理された環境で git の競合を解決するには、まず hawk.lock ファイルを削除します。meta.yaml ファイルに移動して競合を解決し、このブランチをマージします。

マージ後、ターミナルで maestro env install コマンドを実行して hawk.lock ファイルを再生成し、管理された環境を再インストールします。

6. 管理された環境をアップグレードする

管理された環境をより新しいバージョンにアップグレードするには、まず hawk.lock ファイルを削除します。次に、/home/user/envs/default フォルダーを削除します（rm -rf /home/user/envs/default）。最後に、ターミナルで maestro env install コマンドを実行して hawk.lock ファイルを再生成します。環境は、アップグレードされたライブラリバージョンで再インストールされます。

RStudio® および Shiny® は Posit™ の商標です。

記載されているすべての第三者の商標（ロゴおよびアイコンを含む）は、それぞれの所有者に帰属します。提携関係や推奨を示唆するものではありません。