Spotfireに搭載されているR言語エンジンのTERRとの連携方法

1. © Copyright 2000-2015 TIBCO Software Inc.
SpotfireとTERRの連携方法

2. TERRとは
Spotfire5.0以降のバージョンでは
TIBCO Enterprise Runtime for R ( 以下TERR）と呼ばれるR言語の処理エンジ
ンが搭載されています。
このエンジンを使用することで、Spotfireの可視化と
高度な統計解析や数理モデルを用いた分析が可能になります。
この資料ではTERRとの下記の連携方法を記載しています。
① TERRからSpotfireへのデータの受取
② SpotfireからTERRへパラメータを渡す
③ SpotfireからデータをTERRに渡す
※Spotfire Serverに接続されている必要がありますので、サーバーにログインし
た状態で操作を実施して下さい。

3. 事前準備
最初にSpotfireに搭載されているTERRを使用するように設定します。
「ツール」→「オプション」を選択し「データ関数」を選びます。
「ローカルにインストールされた…..」にチェックを入れ、カスタムURLにはダミーの
URLを指定しておきます。

4. TERRからのデータを受け取る
TERRからデータをSpotfireで受け取る方法です。
まずはR言語を記載した関数を登録する必要がありますので、
「ツール」→「データ関数の登録」を選択します。
タイプは「Rスクリプト – TIBCO Enterprise Runtime for R」を選択してください。

5. 記載スクリプト
retDataTable <- rnorm
( 100 )
retDataTableに100個のランダ
ムな値を格納します。
TERRからのデータを受け取る
スクリプトを記載します。
今回は正規分布に従ったランダムな値を100つ発生させ、Spotfire側で受け取ります。

6. TERRからのデータを受け取る
テーブルの受取設定
スクリプトに記載したretDataTableをSpotfire側で受け取る設定です。
「出力パラメータ」で「追加」を押して、retDataTableをタイプ「テーブル」で追加してください。

7. TERRからのデータを受け取る
スクリプトの実行
「実行」ボタンを押します。出力パラメータが設定されているので、
Spotfire側でどのように受け取るのか指定します。
「出力」タブでretDataTableを「データテーブル」「新しいデータテーブルの作成」とします。

8. TERRからのデータを受け取る
結果の確認
新しいテーブル( retDataTable) が作成され、指定された通り100行分のデータが確認できます。
これでTERRからデータを受け取る事が出来ました。
試しにヒストグラムを作成してみましょう。

9. TERRへパラメータを渡す
TERRからデータを受け取る事が出来ましたが、
モデルのパラメータをSpotfireから渡す事も出来ます。
今回は発生させる行数を指定できるようにします。
まずはプロパティと言う機能を使用し、数値を入力できるようにします。
プロパティはテキストエリアに設置できますので、
まずは、テキストエリアを作成します。
その次に「プロパティコントロールの挿入」を選び、
「入力フィールド」を選択してください。

10. TERRへパラメータを渡す
プロパティコントロールの画面が開きます。
「新規作成」をクリックして新しいプロパティを作成します。
プロパティ名は「inputNum」でデータ型は「Integer」、値は100にしてください。
これでテキストエリア上に入力可能なフィールドが追加されます。

11. TERRへパラメータを渡す
作成したプロパティをTERRで使用します。
先ほど作成したデータ関数を開きます。
「データ関数の登録」から「開く」でrandGeneratorを選択します。

12. 変更前：retDataTable <- rnorm ( 100 )
変更後：retDataTable <- rnorm ( inputNum )
TERRへパラメータを渡す
パラメータの入力を追加します。
「パラメーターの入力」タブで「追加」を押して、入力パラメータ「inputNum」タイプは｢値」、デー
タ型は「Integer」を指定します。
その後、スクリプトを入力パラメータを使用するよう書き換えます。

13. TERRへパラメータを渡す
スクリプトの実行
「保存」後「実行」を押してください。
今回は、入力パラメータと出力パラメータを両方指定します。
入力パラメータの設定
スクリプトでinputNumが入力パラメーターとして設定されているので、「文書のプロパティ」から
「inputNum」を指定します。
出力パラメータの設定
出力パラメータは前回と同じくデータテーブルを設定しますが「既存のデータテーブルの置換」を選択
し、上書き設定します。
また、「関数を自動的に更新」チェックを入れておくと、
パラメータが変更されると即座に結果も反映されます。

14. TERRへパラメータを渡す
結果の確認
これで入力した値分の行を返すようになりました。
テキストエリアに設置したプロパティの値を変えると、自動的にデータ量も変更されま
す。
値を10000と入力すると10000行分のデータが返ってきます。

15. スクリプトは下記の通りです。
outTable <- scale ( inTable )
TERRへデータを渡す
TERRにデータを渡します
Spotfireで取り込んでいるデータをTERRに渡して処理を行う事が出来ます。
先ほど作成したヒストグラムの一部のデータをTERRに渡して正規化したデータを返
してもらうようにします。
データ範囲をマークし、新しいデータ関数を登録します。

16. TERRへデータを渡す
次は入出力(inTable,outTable)パラメータの設定をします。
入力パラメータ
入力タブで「追加」を押して、入力パラメータ名「inTable」、タイプ「テーブル」、データ型「IntegerとReal」で登
録します。
出力パラメータ
出力タブで「追加」を押して、結果パラメータ「outTable」、タイプ「テーブル」の設定をします。

17. TERRへデータを渡す
関数をscaleという名前で保存します。
「実行」ボタンを押してください。

18. TERRへデータを渡す
関数に入出力の設定があるため、実行時に指定します。
入力パラメータ
Spotfireから渡すデータテーブルを指定します。
inTableの「入力ハンドラ」をカラムに設定し、データテーブルretDataTableを設定、「カラムの選
択」でretDataTableカラムを選択します。
このままだと全てのデータが
TERRに渡されます。
マークしている範囲を渡したいの
で「制限の基準」を「マークされ
たロー」にチェックを入れます。

19. TERRへデータを渡す
出力パラメータ
TERRの計算結果を受け取るテーブルを指定します。
新規テーブルとして受け取りますので、出力ハンドラを「データテーブル」、「新しいデータテーブル
の作成」を選択します。
「関数を自動的に更新」もチェックを入れます。

20. TERRへデータを渡す
outTableに結果が返されますので、こちらのテーブルを使用して
ヒストグラムを作成してください。
retDataTableのマーク範囲を変更すると、その都度outTableが更新されます。

21. 登録したスクリプトの編集
分析ファイル内に登録されているデータ関数は編集可能です。
編集→「データ関数のプロパティ」を開いてください。
「スクリプトの編集」 R言語のスクリプトを編集します。
「パラメータの編集」 SpotfireとTERRの引数を編集します。

22. C:¥Program Files (x86)¥TIBCO¥SpotfireX.X¥X.X.X¥Modules¥TIBCO Enterprise Runtime for
R_1.5.0.141¥engine¥bin
TERR：パッケージの追加
TERRは通常のRと同じようにCRANからパッケージをインストールする事が可能です。
インストールするためにTERRをコマンドラインモードで起動する必要があります。
バージョンにより異なりますが、下記フォルダにTERRの本体がありますので、そちらを起動します。
TERRを起動し、install.packagesコマンドを実行することでパッケージをインストールできます。
※CRANの全てのパッケージに対応できてはいません。

23. TERR：パッケージの追加
インストールしたパッケージを利用するにはデータ関数の登録の際「パッケージ」に記載します。