R 工具
R 工具
重要
预测工具 2022.1 更新现 已推出 ，且包含 R 4.1.3。安装更新以在您的自定义代码中使用来自 CRAN 的新 R 软件包。如果您当前或新的 R 代码使用以前安装的软件包，则不需要此更新。
R 工具是供 R 用户使用的代码编辑器。R 是一个开源代码库，可用于统计分析。在使用此工具之前，您应该已经熟悉 R。
Designer 中的 R
Designer 读取有效的 R 脚本并将其传输于该工具。R 工具的输出与 R 的输出吻合。
R 支持
尽管 Designer 接受客户 R 代码，但 Alteryx 并不为客户 R 代码提供支持。
Alteryx 使用 R 脚本的全局变量
[AlteryxFullUpdate]
进行元信息更新。当您将
AlteryxFullUpdate
设置为
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)
进行输出。
插入代码 ：列出 Designer 特有的命令，您可以将这些命令注入 R 代码编辑器。您应该将这些命令与典型的 R 命令一起使用。这个列表并未囊括一切。
R 和界面工具
：要访问 R 工具中的界面工具，请输入
%Question.tool_name%
，其中
tool_name
是界面工具的名称，您可以在
配置
窗口的
注释
选项卡下找到该名称。
读取输入
读取输入
：此函数读取连接好的数据输入。每个连接的输入都会创建一个单独的选项，按连接顺序列出。选择列出的输入以在代码编辑器中插入连接。无论您将
AlteryxFullUpdate
设置为
TRUE
还是
FALSE
，您都可以使用此函数。
read.Alteryx()
函数将输入数据流式传输到 R 环境中。
可选参数
行名称
：一个可选参数，用于包含名为 RowNames 的新列，此列填充了要作为行标题处理的第一列数据。默认情况下，Designer 会将此参数设置为
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")
输入元信息 ：此选项从输入而不是数据中读入元信息。该函数返回包含元信息的数据帧。数据帧的行表示输入数据的每一列，而适用的元信息显示在六列中：
Name ：字符串，列名。
类型 ：字符串，数据类型。
大小 ：整数，数据类型的大小（以字节为单位）。
Scale ：整数，FixedDecimal 中的小数位数。
Source ：字符串，列类型的元数据，后跟初始值。
Description ：字符串，可以用说明字符串填充的可选列。
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()
函数之前，应该使用
data.frame()
函数将数据转换为数据帧。如果数据没有转换为数据帧，Alteryx 会尝试转换为数据帧，但这可能无法按预期工作。
可选参数
源 ：此可选参数将字符串添加到元数据输出中的 源 列。
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
AlteryxGraph(5, width=576, height=576) xPoints<- c(1, 2, 3, 4) yPoints <- c(2, 4, 6, 8) plot(xPoints, yPoints) invisible(dev.off())
更新/元信息
if(AlteryxFullUpdate)... ：此函数可以与全局变量 [AlteryxFullUpdate]一起用。
write.AlteryxAddFieldMetaInfo
：此函数将元信息从单个列添加到指定的输出。当
AlteryxFullUpdate = FALSE
时，您不能使用此函数。
可选参数
您可以使用以下参数的任意组合。
nOutput
：将列的元数据添加到输出。
name
：指定要输出的列的名称。如果您提供的名称无效，则会发生错误。
fieldType
：表示列的数据类型。如果您提供的字段类型无效，则会发生错误。您可能需要根据字段类型手动更新
大小
和
小数位数
。Designer 通过将多种字段类型转换为有效字段类型来接受它们。
size
：指定列的大小。Designer 会自动将此值分配给许多字段类型。
scale
：指定列值的小数位数。Designer 要求您为
FixedDecimal
字段类型指定此值，而不用对其他字段类型指定此值。
有效的 FieldType 字符串 | 大小被覆盖 | 小数位数被覆盖 | 转换为有效的 FieldType |
|---|---|---|---|
布尔值 | 自动 | 逻辑 | |
字节（Byte） | 自动 | ||
Int16 | 自动 | ||
Int32 | 自动 | 整数 | |
Int 64 | 自动 | ||
FixedDecimal | 手动 | 手动 | |
浮点数 | 自动 | ||
Double (双精度浮点数) | 自动 | 数值 | |
字符串 | 手动 | ||
WString | 手动 | ||
V_String | |||
V_WString | 因素；字符 | ||
日期 | 自动 | ||
时间 | 自动 | ||
日期时间 | 自动 | ||
Blob | |||
空间对象 |
source
：使用描述列来源的字符串来填充此可选列。
description
：用说明字符串填充此可选列。
write.AlteryxGraphMetaInfo
：此函数使用
AlteryxGraph()
将指定输出的元信息设置为 R 脚本图。当
AlteryxFullUpdate = FALSE
时，您不能使用此函数。
可选参数
nOutput
：指定要在其中添加列的元数据的输出。