はじめに

このページでは、Palantir R SDK を使用して Foundry でデータ変換を記述する際の構造と、利用可能な設定オプションについて説明します。

リポジトリの構造

各 R トランスフォームは、トランスフォーム仕様によって定義および設定されます。定義は YAML 形式で記述し、.transforms フォルダーに保存します。リポジトリのプロジェクトの全内容は実行時に利用可能になり、トランスフォームで使用できます。

.
├── .transforms
|    └── happiness_ranking.yml
|
├── project
|    └── src
|        └── top_10.R
└── .Rprofile

Code Workspaces から公開された R トランスフォームの場合、トランスフォーム仕様ファイルは UI に表示され、UI から設定できます。

シンプルな R トランスフォームを記述して設定する

以下の例では、表形式のデータセットを読み取り、R パッケージ dplyr を使用してフィルターを適用し、絞り込み結果を含む出力データセットを生成するシンプルなデータ変換を記述します。

Copied!
1
2
3
4
5
6
library(foundry)
library(dplyr)

happiness_2019 <- datasets.read_table("happiness_2019")
top_10 <- happiness_2019 %>% filter(Overall_rank <= 10)
datasets.write_table(top_10, "top_10_happiest_countries")

以下は、このトランスフォームの定義を含む対応するトランスフォーム仕様ファイルです。

dataset.rid フィールドを、入力データセットと出力データセットのデータセット RID に置き換えます。現在、チェック時に新しい出力データセットを作成することはサポートされていないため、出力データセットは事前に手動で作成する必要があります。

inputs または outputs リストに新しい項目を追加することで、入力と出力を追加できます。

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
inputs:
- alias: "happiness_2019"
  properties:
    type: "dataset"
    dataset:
      rid: "<input dataset rid here>"
outputs:
- alias: "top_10_happiest_countries"
  properties:
    type: "dataset"
    dataset:
      rid: "<output dataset rid here>"
- alias: "second-output"
  properties:
    type: "dataset"
    dataset:
      rid: "<second output dataset rid here>"
runtime:
  type: "rscript"
  rscript:
    identifier: "R.4.1.x"
    filePath: "project/src/top_10.R"

ランタイムの設定：

• identifier：トランスフォームのランタイムを識別します。たとえば、R.4.1.x は R のマイナーバージョンリリース4.1を指します。
• filePath：プロジェクトのルートから、実行する R スクリプトファイルへの相対ファイルパスです。

非構造化データを書き込む

この例では、ggplot2 を使用して線形回帰直線を含むプロットを生成し、プロットを PNG として出力データセットに保存します。

Copied!
1
2
3
4
5
6
7
8
9
10
11
library(foundry)
library(ggplot2)

happiness_2019 <- datasets.read_table("happiness_2019")

png("/tmp/model_plot.png")
plot <- ggplot(happiness_2019, aes(GDP_per_capita, Overall_rank)) + geom_point() 
plot + stat_smooth(method = "lm", formula = y ~ x, geom = "smooth")
dev.off()

datasets.upload_files("/tmp/model_plot.png", "happinessGDP_plot")

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
inputs:
- alias: "happiness_2019"
  properties:
    type: "dataset"
    dataset:
      rid: "<input dataset rid here>"
outputs:
- alias: "happinessGDP_plot"
  properties:
    type: "dataset"
    dataset:
      rid: "<output dataset rid here>"
runtime:
  type: "rscript"
  rscript:
    identifier: "R.4.1.x"
    filePath: "project/src/gdp_plot.R"

R パッケージと環境を管理する

デフォルトでは、R トランスフォームのリポジトリには、Posit™ Package Manager と Bioconductor をミラーリングするアーティファクトリポジトリが設定されています。renv ↗ を使用して R パッケージをインストールし、トランスフォームの R 環境を管理することを推奨します。

Code Workspace RStudio® Workbench では、renv がデフォルトでインストールされており、利用可能です。パッケージパネルで利用可能なパッケージを検索し、それらをインストールするための R コードを生成できます。

R トランスフォームは、renv.lock からの復元もサポートしています。リポジトリ内に renv.lock ファイルがある場合、トランスフォームの冒頭または .Rprofile で renv.restore() を実行して R 環境を復元できます。

以下の例は、R トランスフォームに必要なパッケージをインストールし、プロジェクトのライブラリの状態を保存する renv.lock ファイルを生成するために実行できる R コマンドを示しています。生成されたロックファイルは、コミットして、後でプロジェクトを復元する際に使用できます。

Copied!
1
2
3
renv::install("dplyr")
renv::install("arrow")
renv::snapshot()

---

RStudio® は Posit™ の商標です。

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