Herramienta R
Herramienta R
Importante
La actualización de herramientas predictivas 2022.1 ya está disponible e incluye R 4.1.3. Instala la actualización para utilizar los nuevos paquetes R de CRAN en tu código personalizado. No necesitas esta actualización si tu código R actual o nuevo hace uso de paquetes instalados previamente.
La herramienta R es un editor de código para usuarios de R. R es una base de código de código abierto que puedes utilizar para realizar análisis estadístico. Debes ser competente en R antes de utilizar esta herramienta.
R en Alteryx Designer
Designer lee scripts de R válidos y los pasa a través de la herramienta. La salida de la herramienta R coincide con la salida en R.
Compatibilidad con R
Aunque Designer acepta código R de cliente, Alteryx no proporciona compatibilidad con código R de cliente.
Alteryx utiliza
[AlteryxFullUpdate]
, una variable global para script de R, para las actualizaciones de metainformación. Las actualizaciones completas de metainformación se producen cuando se establece
AlteryxFullUpdate
en
TRUE
. Esto ocurre cuando se abre por primera vez el flujo de trabajo o se actualiza con la tecla F5.
No se pueden utilizar las funciones estándar de lectura y escritura cuando
AlteryxFullUpdate = TRUE
. Si un script de R contiene una función como
read.Alteryx
o
write.Alteryx
mientras
AlteryxFullUpdate = TRUE
, se produce un error.
La metainformación que se envía cuando
AlteryxFullUpdate = TRUE
puede diferir de la metainformación que genera Designer cuando se ejecuta el flujo de trabajo. Esto puede provocar errores.
Configurar la herramienta
La herramienta R acepta varias entradas y las etiqueta en orden de conexión ( #1 , #2 y así sucesivamente). La herramienta genera hasta cinco flujos de datos desde sus anclas, etiquetados del 1 al 5 . Las referencias en el código deben seguir las mismas diferencias de formato entre entradas y salidas.
Importante
En las descripciones a continuación,
#1
se refiere a cualquier etiqueta de conexión de entrada y
5
se refiere a cualquier ancla de salida.
La herramienta R utiliza la función
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5)
para la salida.
Insertar código : enumera los comandos específicos de Designer que se pueden integrar en el editor de código R. Se deben utilizar esos comandos con los comandos R típicos. La lista no es completa.
R y herramientas de interfaz
: para acceder a las herramientas de interfaz en la herramienta R, ingresa
%Question.tool_name%
, donde
tool_name
es el nombre de la herramienta de interfaz, que puedes encontrar en la pestaña
Anotación
de la ventana
Configuración
.
Leer entrada
Leer entrada
: esta función lee una entrada de datos conectada. Cada entrada conectada crea una opción independiente que se enumera por orden de conexión. Selecciona una entrada de la lista para insertar la conexión en el Editor de código. Puedes utilizar esta función independientemente de si estableces
AlteryxFullUpdate
en
TRUE
o
FALSE
.
La función
read.Alteryx()
transmite los datos de entrada al entorno de R.
Parámetro opcional
Nombres de filas
: un parámetro opcional que permite incluir una nueva columna titulada Nombres de filas, que se rellena con la primera columna de datos que se tratarán como encabezados de fila. De forma predeterminada, Designer define este parámetro en
FALSE
.
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, TRUE)
como marco de datos : esta opción lee una tabla de datos. No tiene otros parámetros.
read.Alteryx("#1", mode="data.frame")
como marco de datos: en trozos : esta opción lee una tabla de datos grande. Especifica la cantidad de registros que deseas que procese a la vez.
read.Alteryx("#1", 50000, mode="data.frame")
como lista : esta opción lee objetos espaciales.
read.Alteryx("#1", mode="list")
como lista: en trozos : esta opción lee una gran cantidad de registros espaciales. Especifica la cantidad de registros que deseas procesar a la vez.
read.Alteryx("#1", 50000, mode="list")
Metainfo de entrada : esta opción lee la metainformación de entrada en lugar de los datos. La función devuelve un marco de datos que contiene la metainformación. Las filas del marco de datos representan cada columna de los datos de entrada, mientras que la metainformación aplicable se muestra en seis columnas:
Nombre : cadena, el nombre de la columna.
Tipo : cadena, el tipo de dato.
Tamaño : número entero, el tamaño del tipo de dato en bytes.
Escala : número entero, la cantidad de decimales en FixedDecimal.
Origen : cadena, los metadatos sobre el tipo de columna, seguidos del valor inicial.
Descripción : cadena, columna opcional que se puede rellenar con una cadena de descripción.
read.AlteryxMetaInfo("#1")
Definir el progreso
Definir el progreso : esta función informa sobre el progreso en el ícono de herramienta de un flujo de trabajo. Selecciona una de estas opciones de incremento:
25 %
50 %
75 %
100 %
AlteryxProgress(0.25)
Mensaje de salida
Mensaje de salida : esta función muestra un mensaje en la ventana Resultados . La prioridad del mensaje determina cuándo Designer informa sobre el mensaje. Ve a Configuración de flujo de trabajo para cambiar el comportamiento de visualización de mensajes.
Prioridad del mensaje
Mensaje de prioridad normal : el mensaje solo aparece cuando la herramienta R está visible en el lienzo de un flujo de trabajo en ejecución. Si la herramienta R se encuentra dentro de una macro, Designer no muestra el mensaje.
AlteryxMessage("message", msg.consts$INFO, priority.consts$LOW)
Mensaje transitorio de prioridad normal : el mensaje se muestra en lugar de un mensaje existente que emite la misma herramienta.
AlteryxMessage("message", msg.consts$INFO, priority.consts$LOW, 5)
Advertencia de prioridad media : el mensaje aparece cuando la herramienta R está visible en el lienzo del flujo de trabajo en ejecución o cuando se encuentra dentro de una macro del flujo de trabajo en ejecución.
AlteryxMessage("message", msg.consts$WARNING, priority.consts$MEDIUM)
Error de conversión de campo : el mensaje aparece cuando no se pueden convertir datos de un tipo de campo en otro o cuando los datos no se ajustan a la especificación de campo.
AlteryxMessage("message", msg.consts$FIELD_CONVERSION_ERROR)
Error de prioridad alta : el mensaje aparece independientemente de la relación de la herramienta R con el flujo de trabajo en ejecución. Designer trata los errores de conversión de campo como prioridad alta.
AlteryxMessage("message", msg.consts$ERROR, priority.consts$HIGH)
Escribir salida
Escribir salida : esta opción envía un flujo de datos a partir de un ancla de salida. Todas las anclas pueden producir datos o un solo gráfico.
Marco de datos
Como práctica recomendada, debes convertir datos a un marco de datos con la función R
data.frame()
antes de usar la función
write.Alteryx()
. Si los datos no se convierten en un marco de datos, Alteryx intenta hacerlo, pero puede que no funcione como se espera.
Parámetros opcionales
Origen : este parámetro opcional agrega una cadena a la columna Origen en la salida de metadatos.
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, source="customer data from 2012 repo")
Nombres de filas : este parámetro opcional incluye una nueva columna titulada Nombres de filas, que se rellena con la primera columna de datos como encabezados de fila. El valor predeterminado de este parámetro es FALSE .
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, TRUE)
Dependencias de empaquetado
Designer no detecta automáticamente los archivos adicionales que acompañan al código R como dependencias del flujo de trabajo. Si necesitas empaquetar el flujo de trabajo y el código R tiene sus propias dependencias, incluye cualquier archivo adicional mediante la Configuración de la herramienta en la ventana Configuración .
Crear gráfico
Crear gráfico : esta opción envía un gráfico del análisis. Designer trata la salida como un fragmento de generación de informes que las herramientas Generación de informes pueden leer. Selecciona una de estas opciones para el tamaño del gráfico:
6 x 6 pulgadas - 96 dpi
8 x 10 pulgadas - 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())
Actualizar/metainformación
if(AlteryxFullUpdate)… : esta función utiliza la variable global [AlteryxFullUpdate].
write.AlteryxAddFieldMetaInfo
: esta función agrega la metainformación de una sola columna a la salida denominada. No se puede utilizar esta función cuando
AlteryxFullUpdate = FALSE
.
Parámetros opcionales
Puedes utilizar cualquier combinación de los siguientes parámetros.
nOutput
: agrega metadatos de una columna a la salida.
name
: especifica el nombre de la columna que deseas enviar. Si proporcionas un nombre no válido, se produce un error.
fieldType
: representa el tipo de dato de una columna. Si proporcionas un tipo de campo no válido, se produce un error. Es posible que necesites actualizar manualmente el
tamaño
y la
escala
según el tipo de campo. Designer acepta varios tipos de campo y los convierte en tipos de campo válidos.
size
: especifica el tamaño de la columna. Designer asigna automáticamente este valor a muchos tipos de campo.
scale
: especifica la cantidad de decimales para los valores de las columnas. Designer requiere que se especifique este valor para los tipos de campo
FixedDecimal
, pero no para otros tipos de campo.
Cadenas FieldType válidas | Tamaño anulado | Escala anulada | Se convierte en un FieldType válido |
|---|---|---|---|
Booleano | automático | lógico | |
Byte | automático | ||
Int16 | automático | ||
Int32 | automático | entero | |
Int64 | automático | ||
FixedDecimal | manual | manual | |
Float | automático | ||
Doble | automático | numérico | |
Cadena | manual | ||
WString | manual | ||
V_String | |||
V_WString | factor; carácter | ||
Fecha | automático | ||
Hora | automático | ||
Fecha y hora | automático | ||
Blob | |||
Objeto espacial |
source
: rellena esta columna opcional con una cadena que describa los orígenes de la columna.
description
: rellena esta columna opcional con una cadena de descripción.
write.AlteryxGraphMetaInfo
: esta función establece la metainformación de la salida denominada en un gráfico de script de R con
AlteryxGraph()
. No se puede utilizar esta función cuando
AlteryxFullUpdate = FALSE
.
Parámetros opcionales
nOutput
: especifica la salida en la que deseas agregar los metadatos de la columna.