Ferramenta R
Ferramenta R
Importante
A atualização das ferramentas preditivas 2022.1 está agora disponível e inclui a versão do R 4.1.3. Instale a atualização para usar novos pacotes R do CRAN em seu código personalizado. Você não precisa dessa atualização se o seu código R atual ou novo usa os pacotes instalados anteriormente.
A ferramenta R é um editor de código para usuários do R. O R é uma base de código open-source que pode ser usada para análise estatística. Recomenda-se ter proficiência em R para utilizar essa ferramenta.
R no Designer
O Designer lê scripts R válidos e os passa pela ferramenta. A saída da ferramenta R corresponde à saída no R.
Suporte do R
Embora o Designer aceite código R personalizado, a Alteryx não oferece suporte para o código R personalizado.
O Alteryx usa
[AlteryxFullUpdate]
, uma variável global para o script R, para atualizações de metainformações. Atualizações completas de metainformações ocorrem quando você define
AlteryxFullUpdate
como
TRUE
(verdadeiro). Isso acontece quando você abre o fluxo de trabalho pela primeira vez ou o atualiza com a tecla F5.
Não é possível usar funções padrão de leitura e gravação quando
AlteryxFullUpdate = TRUE
. Se um script R contiver uma função como
read.Alteryx
ou
write.Alteryx
enquanto
AlteryxFullUpdate = TRUE
, ocorrerá um erro.
Metainformações passadas para saídas quando
AlteryxFullUpdate = TRUE
podem ser diferentes das metainformações que o Designer gera quando você executa o fluxo de trabalho. Isso pode causar erros.
Configurar a ferramenta
A ferramenta R aceita múltiplas entradas e as rotula pela ordem de conexão ( #1 , #2 e assim por diante). A ferramenta faz a saída de até 5 fluxos de dados pelas suas âncoras, identificadas de 1 a 5 . As referências no código devem seguir as mesmas diferenças de formato entre entradas e saídas.
Importante
Nas descrições abaixo,
#1
refere-se a qualquer rótulo de conexão de entrada e
5
refere-se a qualquer âncora de saída.
A ferramenta R usa a função
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5)
para a saída.
Inserir código : lista de comandos específicos do Designer que você pode injetar no editor de código R. Você deve usar esses comandos com comandos R típicos. A lista não é exaustiva.
Ferramentas de interface e R
: para acessar as ferramentas de interface na ferramenta R, digite
%Question.tool_name%
onde
tool_name
é o nome da ferramenta de interface, que você pode encontrar na guia
Anotação
da janela
Configuração
.
Ler entrada
Ler entrada
: esta função lê uma entrada de dados conectada. Cada entrada conectada cria uma opção separada listada em ordem de conexão. Selecione uma entrada listada para inserir a conexão no editor de código. Essa função pode ser usada independentemente de você definir
AlteryxFullUpdate
como
TRUE
ou
FALSE
.
A função
read.Alteryx()
transmite os dados de entrada para o ambiente R.
Parâmetro opcional
Nomes das linhas
: um parâmetro opcional para incluir uma nova coluna intitulada "RowNames", preenchida com a primeira coluna de dados a ser tratada como cabeçalhos de linha. Por padrão, o Designer define esse parâmetro como
FALSE
.
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, TRUE)
como quadro de dados : essa opção lê uma tabela de dados. Ela não tem outros parâmetros.
read.Alteryx("#1", mode="data.frame")
como quadro de dados: em partes : essa opção lê uma tabela de dados grande. Especifique o número de registros que deseja processar por vez.
read.Alteryx("#1", 50000, mode="data.frame")
como lista : essa opção lê objetos geográficos.
read.Alteryx("#1", mode="list")
como lista: em partes : essa opção lê um grande número de registros espaciais. Especifique o número de registros que deseja processar por vez.
read.Alteryx("#1", 50000, mode="list")
Metainformações da entrada : essa opção lê as metainformações da entrada em vez dos dados. A função retorna um quadro de dados que contém as metainformações. As linhas do quadro de dados representam cada coluna dos dados de entrada, enquanto as metainformações aplicáveis são exibidas em seis colunas:
Name : cadeia de caracteres, o nome da coluna.
Type : cadeia de caracteres, o tipo de dados.
Size : número inteiro, o tamanho do tipo de dados.
Scale : número inteiro, o número de casas decimais em um FixedDecimal.
Source : cadeia de caracteres, os metadados sobre o tipo de coluna, seguido pelo valor inicial.
Description : cadeia de caracteres, uma coluna opcional que você pode preencher com uma cadeia de caracteres de descrição.
read.AlteryxMetaInfo("#1")
Definir progresso
Definir progresso : essa função informa o progresso no ícone da ferramenta em um fluxo de trabalho. Selecione uma destas opções de incremento:
25%
50%
75%
100%
AlteryxProgress(0.25)
Mensagem de saída
Mensagem de saída : essa função exibe uma mensagem na janela Resultados . A prioridade da mensagem determina quando o Designer relata a mensagem. Vá para Configuração do fluxo de trabalho para alterar o comportamento de exibição de mensagens.
Prioridade da mensagem
Mensagem de prioridade normal : a mensagem é exibida somente quando a ferramenta R está visível na tela de um fluxo de trabalho em execução. Se a ferramenta R estiver contida em uma macro, o Designer não exibirá a mensagem.
AlteryxMessage("message", msg.consts$INFO, priority.consts$LOW)
Mensagem transiente de prioridade normal : a mensagem é exibida no lugar de uma mensagem existente que a mesma ferramenta emite.
AlteryxMessage("message", msg.consts$INFO, priority.consts$LOW, 5)
Aviso de prioridade média : a mensagem é exibida quando a ferramenta R está visível na tela do fluxo de trabalho em execução ou está contida em uma macro no fluxo de trabalho em execução.
AlteryxMessage("message", msg.consts$WARNING, priority.consts$MEDIUM)
Erro de conversão de campo : a mensagem é exibida quando não é possível converter dados de um tipo para outro ou quando os dados não se encaixam na especificação do campo.
AlteryxMessage("message", msg.consts$FIELD_CONVERSION_ERROR)
Erro de alta prioridade : a mensagem é exibida independentemente da relação da ferramenta R com o fluxo de trabalho em execução. O Designer trata erros de conversão de campo como prioridade alta.
AlteryxMessage("message", msg.consts$ERROR, priority.consts$HIGH)
Gravar saída
Gravar saída : essa opção gera um fluxo de dados a partir de uma âncora de saída. Todas as âncoras podem produzir dados ou um único gráfico.
Quadro de dados
Como prática recomendada, você deve converter dados em um quadro de dados com a função do R
data.frame()
antes de usar a função
write.Alteryx()
. Se os dados não forem convertidos em um quadro de dados, o Alteryx tentará convertê-los, mas isso pode não funcionar como esperado.
Parâmetros opcionais
Source : esse parâmetro opcional adiciona uma cadeia de caracteres à coluna Origem na saída de metadados.
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, source="customer data from 2012 repo")
Row Names : esse parâmetro opcional inclui uma nova coluna intitulada "RowNames", preenchida com a primeira coluna de dados como cabeçalhos de linha. O padrão desse parâmetro é FALSE .
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, TRUE)
Dependências de empacotamento
O Designer não detecta automaticamente como dependências do fluxo de trabalho arquivos extras que acompanham o seu código R . Se você precisar empacotar seu fluxo de trabalho e seu código R tiver suas próprias dependências, inclua quaisquer arquivos adicionais usando a configuração da ferramenta na janela Configuração .
Criar gráfico
Criar gráfico : essa opção gera um gráfico da análise. O Designer trata a saída como um fragmento de relatório que as ferramentas da categoria Geração de Relatórios podem ler. Selecione uma destas opções para o tamanho do gráfico:
6x6 polegadas - 96 dpi
8x10 polegadas - 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())
Atualizar/Metainformações
if(AlteryxFullUpdate)... : essa função funciona com a variável global [AlteryxFullUpdate].
write.AlteryxAddFieldMetaInfo
: essa função adiciona as metainformações de uma única coluna à saída nomeada. Não é possível usar essa função quando
AlteryxFullUpdate = FALSE
.
Parâmetros opcionais
Você pode usar qualquer combinação dos parâmetros abaixo.
nOutput
: adiciona metadados para uma coluna à saída.
name
: especifique o nome da coluna que deseja gerar. Se você fornecer um nome inválido, ocorrerá um erro.
fieldType
: representa o tipo de dados de uma coluna. Se você fornecer um tipo de campo inválido, ocorrerá um erro. Talvez seja necessário atualizar manualmente o
tamanho
e a
escala
com base no tipo de campo. O Designer aceita vários tipos de campo, convertendo-os em tipos de campo válidos.
size
: especifique o tamanho da coluna. O Designer atribui automaticamente esse valor a muitos tipos de campo.
scale
: especifique o número de casas decimais para valores de coluna. O Designer requer que você especifique esse valor para os campos do tipo
FixedDecimal
, mas não para outros tipos.
Cadeias válidas para fieldType | Substituição de tamanho | Substituição de escala | Conversão em um fieldType válido |
|---|---|---|---|
Bool | automático | lógico | |
Byte | automático | ||
Int16 | automático | ||
Int32 | automático | número inteiro | |
Int64 | automático | ||
FixedDecimal | manual | manual | |
Float | automático | ||
Double | automático | numérico | |
String | manual | ||
WString | manual | ||
V_String | |||
V_WString | fator; caractere | ||
Date | automático | ||
Time | automático | ||
DateTime | automático | ||
Blob | |||
Objeto de geografia |
source
: preencha essa coluna opcional com uma cadeia de caracteres que descreva as origens da coluna.
description
: preencha essa coluna opcional com uma cadeia de caracteres de descrição.
write.AlteryxGraphMetaInfo
: essa função define as metainformações da saída nomeada para um gráfico de script R com
AlteryxGraph()
. Não é possível usar essa função quando
AlteryxFullUpdate = FALSE
.
Parâmetros opcionais
nOutput
: especifique a saída na qual você deseja adicionar os metadados da coluna.