Designer R tool

R ツール

バージョン:
2021.3
Last modified: October 21, 2020

Rツールは、R ユーザー向けのコードエディターです。R は、統計分析に使用できるオープンソースのコードベースです。このツールを使用する前に、R を習熟しておく必要があります。

Alteryx Public Gallery との互換性

gallery.alteryx.com でワークフローの公開を予定していますか? まず、免除の申請 を行なう必要があります。この制限は、Alteryx Server と Alteryx Gallery のプライベートインスタンスには適用されません。

Designer の R

Designer は有効な R スクリプトを読み取り、ツールに渡します。Rツールからの出力は、R の出力と一致します。

R のサポート

Designer は顧客の R コードを受け入れますが、Alteryx は顧客の R コードをサポートしません。

Alteryxは、R スクリプトのグローバル変数である [AlteryxFullUpdate] をメタ情報の更新に使用します。AlteryxFullUpdat TRUE に設定すると、完全なメタ情報の更新が発生します。これは、ワークフローを最初に開いたとき、または F5 キーを使用して更新したときに発生します。

次の場合は、標準の読み取りおよび書き込み関数を使用できません: AlteryxFullUpdate = TRUE。R スクリプトに read.Alteryx または write.Alteryx などの関数が含まれているときに、AlteryxFullUpdate = TRUE の場合、エラーが発生します。

AlteryxFullUpdate = TRUE の時に出力に渡すメタ情報がワークフローの実行時にDesigner が生成するメタ情報と異なる場合があります。これにより、エラーが発生する可能性があります。

ツール設定

Rツールは複数の入力を受け入れ、それらを接続順にラベル付けします (例: #1#2 など) ツールは、アンカーから最大 5 つのデータストリーム出力し、1 から 5 のラベルを付けます。コード内の参照は、入力と出力の形式の違いが同じでなければなりません。

以下の説明では、#1は入力接続ラベルを表し、#5 は出力アンカーを表します。

Rツールは出力に以下の関数を使用します: write.Alteryx(DATA_VARIABLE_TO_WRITE, 5)

コードを挿入: R コードエディターに挿入できるDesigner 固有のコマンドを一覧表示します。これらのコマンドは、一般的な R コマンドで使用する必要があります。リストは包括的ではありません。

R とインターフェースツール: Rツールのインターフェースツールにアクセスするには、設定 ウィンドウの 注釈 タブで tool_name がインターフェースツールの名前となっている箇所に %Question.tool_name% と入力します。

入力の読み込み

入力の読み取り: この関数は、接続されたデータ入力を読み込みます。接続された各入力は、接続順にリストされた個別のオプションを作成します。リストされた入力を選択して、コードエディターに接続を挿入します。AlteryxFullUpdateTRUE または FALSE に設定したかどうかに関係なく、この機能を使用できます。

read.Alteryx() 関数ストリームは入力データを R 環境にストリーミングします。

オプションパラメーター

行名: RowNames というタイトルの新しい列を含めるオプションパラメーターで、行ヘッダーとして扱われるデータの最初の列が入力されます。既定では、このパラメータは FALSE に設定されています。

write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, TRUE)

データフレーム: このオプションは、データテーブルを読み取ります。他のパラメーターはありません。

read.Alteryx("#1", mode="data.frame")

データフレーム: チャンク: このオプションは、大きなデータテーブルを読み込みます。一度に処理するレコードの数を指定します。

read.Alteryx("#1", 50000, mode="data.frame")

リスト: このオプションは、空間オブジェクトを読み込みます。

read.Alteryx("#1", mode="list")

リスト: チャンク: このオプションは、多数の空間レコードを読み取ります。一度に処理するレコードの数を指定します。

read.Alteryx("#1", 50000, mode="list")

入力メタ情報: このオプションは、データではなく入力からメタ情報を読み込みます。この関数は、メタ情報を含むデータフレームを返します。データフレームの行は入力データの各列を表し、該当するメタ情報は 6 つの列に表示されます。

  • 名前: 文字列、列名
  • データ型: 文字列、データ型
  • サイズ: 整数、データ型のサイズ (バイト単位)
  • スケール: 整数、固定小数点の小数点以下の桁数
  • ソース: 文字列、列タイプに関するメタデータ、それに続く開始値
  • 説明: 文字列、説明文字列を入力できるオプション列

read.AlteryxMetaInfo("#1")

進捗状況の設定

進捗を設定: この関数は、ワークフローのツールアイコンの進行状況を報告します。次のいずれかの増分オプションを選択します。

  • 25%
  • 50%
  • 75%
  • 100%

AlteryxProgress(0.25)

出力メッセージ

出力メッセージ: この関数は、結果 ウィンドウにメッセージを表示します。メッセージの優先度は、Designer がメッセージを報告するタイミングで決まります。メッセージの表示動作を変更するには、ワークフロー設定 を参照してください。

メッセージの優先度

重要度が通常のメッセージ: メッセージは、Rツールが実行中のワークフローのキャンバスに表示されている場合にのみ表示されます。Rツールがマクロ内に含まれている場合、Designer はメッセージを表示しません。

AlteryxMessage("message", msg.consts$INFO, priority.consts$LOW)

通常優先度の一時メッセージ: メッセージは、同じツールが発行する既存のメッセージの代わりに表示されます。

AlteryxMessage("message", msg.consts$INFO, priority.consts$LOW, 5)

中優先度の警告: メッセージは、Rツールが実行中のワークフローのキャンバスに表示されるか、実行中のワークフローのマクロ内に含まれている場合に表示されます。

AlteryxMessage("message", msg.consts$WARNING, priority.consts$MEDIUM)

フィールド変換エラー: このメッセージは、あるフィールドタイプから別のフィールドタイプにデータを変換できない場合、またはデータがフィールド仕様に適合しない場合に表示されます。

AlteryxMessage("message", msg.consts$FIELD_CONVERSION_ERROR)

高優先度のエラー: メッセージは、Rツールと実行中のワークフローの関係に関係なく表示されます。Designer はフィールド変換エラーを高優先度として扱います。

AlteryxMessage("message", msg.consts$ERROR, priority.consts$HIGH)

出力の書き込み

出力の書き込み: このオプションは、出力アンカーからのデータストリームを出力します。すべてのアンカーは、データまたは単一のグラフを作成できます。

データフレーム

ベストプラクティスとして、write.Alteryx() 関数を使用する前に R の data.frame() 関数を使用してデータをデータフレームに変換する必要があります。データがデータフレームに変換されない場合、Alterx はデータフレームへの変換を試みますが、これは期待どおりに機能しない可能性があります。

オプションパラメーター

ソース: このオプションパラメーターは、メタデータ出力の Source 列に文字列を追加します。

write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, source="customer data from 2012 repo")

行名: このオプションパラメーターは、RowNames というタイトルの新しい列が含まれ、データの最初の列が行ヘッダーとして入力されます。このパラメーターは既定で FALSE に設定されています。

write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, TRUE)

パッキングの依存関係

Designerは、R コードに付随する余分なファイルをワークフローの依存関係として自動的に検出しません。ワークフローをパッケージ化する必要があり、R コードに独自の依存関係がある場合は、設定 ウィンドウの ツール設定 を使用して追加のファイルを含めます。

グラフの作成

グラフの作成: このオプションは、分析のグラフを出力します。Designer は、出力をレポートツールが読み取ることができるレポートスニペットとして扱います。次のいずれかのグラフサイズオプションを選択します。

  • 6x6 インチ - 96 dpi
  • 8x10 インチ - 300 dpi
R
  1. AlteryxGraph(5, width=576, height=576)
  2. xPoints <- c(1, 2, 3, 4)
  3. yPoints <- c(2, 4, 6, 8)
  4. plot(xPoints, yPoints)
  5. invisible(dev.off())

更新/メタ情報

if(AlteryxFullUpdate)...: この関数は、グローバル変数 [AlteryxFullUpdate] と連動します。

write.AlteryxAddFieldMetaInfo: この関数は、単一の列のメタ情報を名前付き出力に追加します。AlteryxFullUpdate = FALSE の場合、この関数は使用できません。

オプションパラメーター

以下のパラメーターの組み合わせを使用できます。

nOutput: 列のメタデータを出力に追加します。

name: 出力する列の名前を指定します。無効な名前を指定すると、エラーが発生します。

fieldType: 列のデータ型を表します。無効なフィールドタイプを指定すると、エラーが発生します。フィールドタイプに基づいて、SizeScale を手動で更新する必要があります。Designer は、いくつかのフィールドタイプを有効なフィールドタイプに変換することで受け入れます。

Size: 列のサイズを指定します。Designer は、この値を多くのフィールドタイプに自動的に割り当てます。

Scale: 列値の小数点以下の桁数を指定します。Designer では、固定小数点フィールドタイプにこの値を指定する必要がありますが、他のフィールドタイプは指定しないでください。

有効な FieldType 文字列 サイズ上書き スケール上書き 有効な FieldType に変換
Bool 自動   論理的
Byte 自動    
Int16 自動    
Int32 自動   integer
Int 64 自動    
FixedDecimal 手動 手動  
Float 自動    
Double 自動   numeric

String

手動    
WString 手動    
V_String      
V_WString     因子、文字
Date 自動    
Time 自動    
DateTime 自動    
Blob      
Spatial Object      

Source: このオプションの列に列の起源を説明する文字列を入力します。

description: このオプションの列に説明文字列を入力します。

write.AlteryxGraphMetaInfo: この関数は、名前付き出力のメタ情報を AlteryxGraph() を使用して、R スクリプトグラフに設定します。 AlteryxFullUpdate = FALSE の場合、この関数は使用できません。

オプションパラメーター

nOutput" 列のメタデータを追加する出力を指定します。

役に立ちましたか?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support. Can't submit this form? Email us.