Strumento R
Importante
L'aggiornamento 2022.1 degli strumenti predittivi è ora disponibile e include R 4.1.3. Installa l'aggiornamento per utilizzare nuovi pacchetti R da CRAN nel codice personalizzato. Questo aggiornamento non è necessario se il codice R attuale o nuovo utilizza pacchetti installati in precedenza.
Lo strumento R è un editor di codice per gli utenti R. R è un codebase open source utilizzabile per l'analisi statistica. Dovresti essere un utente esperto di R prima di usare questo strumento.
R in Designer
Designer legge gli script R validi e li passa attraverso lo strumento. L'output dello strumento R corrisponde all'output in R.
Supporto di R
Anche se Designer accetta il codice R personalizzato, Alteryx non supporta tale codice.
Alteryx utilizza
[AlteryxFullUpdate]
, una variabile globale per lo script R, per gli aggiornamenti delle meta informazioni. Per gli aggiornamenti completi delle meta informazioni, è necessario impostare
AlteryxFullUpdate
su
TRUE
. Ciò si verifica quando apri il flusso di lavoro per la prima volta o lo aggiorni con il tasto F5.
Non puoi utilizzare le funzioni standard di lettura e scrittura quando
AlteryxFullUpdate = TRUE
. Se uno script R contiene una funzione come
read.Alteryx
o
write.Alteryx
mentre
AlteryxFullUpdate = TRUE
, si verifica un errore.
Le meta informazioni trasferite agli output quando
AlteryxFullUpdate = TRUE
possono differire da quelle generate da Designer durante l'esecuzione del flusso di lavoro. In tal caso, possono verificarsi degli errori.
Configura lo strumento
Lo strumento R accetta più input e li etichetta in ordine di connessione ( #1 , #2 e così via). Lo strumento genera fino a 5 flussi di dati dai suoi ancoraggi, etichettati da 1 a 5 . I riferimenti nel codice devono seguire le stesse differenze di formato tra gli input e gli output.
Importante
Nelle descrizioni seguenti,
#1
si riferisce a qualsiasi etichetta di connessione di input e
5
si riferisce a qualsiasi ancoraggio di output.
Lo strumento R utilizza la funzione
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5)
per l'output.
Inserisci codice : elenca i comandi specifici di Designer che puoi inserire nell'editor di codice R. È necessario utilizzare questi comandi con i comandi R tipici. L'elenco non è completo.
Strumenti R di interfaccia
: per accedere agli strumenti di interfaccia nello strumento R, immetti
%Question.tool_name%
dove
tool_name
è il nome dello strumento di interfaccia, disponibile nella scheda
Annotazione
della finestra
Configurazione
.
Lettura dell'input
Leggi input
: questa funzione legge un input di dati connesso. Ogni input connesso crea un'opzione separata elencata in ordine di connessione. Seleziona un input dall'elenco per inserire la connessione nell'editor di codice. Puoi utilizzare questa funzione indipendentemente dal fatto che
AlteryxFullUpdate
sia impostato su
TRUE
o
FALSE
.
La funzione
read.Alteryx()
trasmette i dati di input nell'ambiente R.
Parametro facoltativo
Nomi di riga
: un parametro facoltativo che consente di includere una nuova colonna denominata Nomi di riga, popolata con la prima colonna di dati da trattare come intestazioni di riga. Per impostazione predefinita, Designer imposta questo parametro su
FALSE
.
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, TRUE)
come frame di dati : questa opzione legge una tabella di dati e non ha altri parametri.
read.Alteryx("#1", mode="data.frame")
come frame di dati: in blocchi : questa opzione legge una grande tabella di dati. Specifica il numero di record da elaborare contemporaneamente.
read.Alteryx("#1", 50000, mode="data.frame")
come elenco : questa opzione legge gli oggetti spaziali.
read.Alteryx("#1", mode="list")
come elenco: in blocchi : questa opzione legge un numero elevato di record spaziali. Specifica il numero di record da elaborare contemporaneamente.
read.Alteryx("#1", 50000, mode="list")
Meta informazioni da input : questa opzione legge le meta informazioni dall'input anziché dai dati. La funzione restituisce un dataframe contenente le meta informazioni. Le righe del dataframe rappresentano ogni colonna dei dati di input, mentre le meta informazioni applicabili vengono visualizzate in sei colonne:
Nome : stringa, il nome della colonna.
Tipo : stringa, il tipo di dati.
Dimensione: numero intero, le dimensioni del tipo di dati in byte.
Scala : numero intero, il numero di posizioni decimali in un valore FixedDecimal.
Origine : stringa, i metadati relativi al tipo di colonna, seguiti dal valore iniziale.
Descrizione : stringa, una colonna facoltativa da popolare con una stringa di descrizione.
read.AlteryxMetaInfo("#1")
Impostazione dello stato
Imposta stato : questa funzione segnala lo stato sull'icona dello strumento in un flusso di lavoro. Seleziona una di queste opzioni di incremento:
25%
50%
75%
100%
AlteryxProgress(0.25)
Messaggio di output
Messaggio di output : questa funzione mostra un messaggio nella finestra Risultati . La priorità del messaggio determina quando viene segnalato da Designer. Consulta Configurazione del flusso di lavoro per modificare la visualizzazione dei messaggi.
Priorità messaggio
Messaggio di priorità normale : il messaggio viene visualizzato solo quando lo strumento R è visibile nell'area di disegno di un flusso di lavoro in esecuzione. Se lo strumento R si trova in una macro, Designer non mostra il messaggio.
AlteryxMessage("message", msg.consts$INFO, priority.consts$LOW)
Messaggio transitorio di priorità normale : il messaggio viene visualizzato al posto di un messaggio esistente generato dallo stesso strumento.
AlteryxMessage("message", msg.consts$INFO, priority.consts$LOW, 5)
Avviso di priorità media : il messaggio viene visualizzato quando lo strumento R è visibile nell'area di disegno del flusso di lavoro in esecuzione o è contenuto in una macro nel flusso di lavoro in esecuzione.
AlteryxMessage("message", msg.consts$WARNING, priority.consts$MEDIUM)
Errore di conversione del campo : il messaggio viene visualizzato quando non è possibile convertire i dati da un tipo di campo a un altro o quando i dati non si adattano alla specifica del campo.
AlteryxMessage("message", msg.consts$FIELD_CONVERSION_ERROR)
Errore di priorità alta : il messaggio viene visualizzato indipendentemente dalla relazione tra lo strumento R e il flusso di lavoro in esecuzione. Designer considera gli errori di conversione dei campi come priorità alta.
AlteryxMessage("message", msg.consts$ERROR, priority.consts$HIGH)
Scrittura di output
Scrivi output : questa opzione genera un flusso di dati da un ancoraggio di output. Tutti gli ancoraggi possono produrre dati o un singolo grafico.
Frame di dati
Come best practice, devi convertire i dati in un frame di dati con la funzione R
data.frame()
prima di usare la funzione
write.Alteryx()
. Se i dati non vengono convertiti in un frame di dati, Alteryx tenterà di eseguire questa operazione, ma potrebbero verificarsi degli imprevisti.
Parametri facoltativi
Origine : questo parametro facoltativo aggiunge una stringa alla colonna Origine nell'output dei metadati.
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, source="customer data from 2012 repo")
Nomi di riga : questo parametro facoltativo include una nuova colonna denominata Nomi di riga, popolata con la prima colonna di dati come intestazioni di riga. Il parametro predefinito è FALSE .
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, TRUE)
Creazione di pacchetti di dipendenze
Designer non rileva automaticamente i file aggiuntivi che accompagnano il codice R come dipendenze del flusso di lavoro. Se devi creare un pacchetto del flusso di lavoro e il tuo codice R dispone di dipendenze proprie, includi eventuali file aggiuntivi tramite Configurazione dello strumento nella finestra Configurazione .
Creazione di grafici
Crea grafico : questa opzione genera un grafico dell'analisi. Designer considera l'output come un frammento di report leggibile dagli strumenti Reporting. Seleziona una delle seguenti opzioni per la dimensione del grafico:
6x6 pollici - 96 dpi
8x10 pollici - 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())
Aggiorna/Meta informazioni
if(AlteryxFullUpdate)... : questa funzione è compatibile con la variabile globale [AlteryxFullUpdate].
write.AlteryxAddFieldMetaInfo
: questa funzione aggiunge le meta informazioni da una singola colonna all'output denominato. Non puoi utilizzare questa funzione se
AlteryxFullUpdate = FALSE
.
Parametri facoltativi
Puoi utilizzare qualsiasi combinazione dei parametri riportati di seguito.
nOutput
: aggiunge i metadati per una colonna all'output.
name
: specifica il nome della colonna da generare. Se il nome fornito non è valido, si verifica un errore.
fieldType
: rappresenta il tipo di dati di una colonna. Se il tipo di campo fornito non è valido, si verifica un errore. Potrebbe essere necessario aggiornare manualmente
Dimensione
e
Scala
in base al tipo di campo. Designer accetta diversi tipi di campo, che converte in tipi di campo validi.
size
: specifica le dimensioni della colonna. Designer assegna automaticamente questo valore a diversi tipi di campo.
scale
: specifica il numero di posizioni decimali per i valori della colonna. Designer richiede di specificare questo valore per i tipi di campo
FixedDecimal
, ma non per altri tipi di campo.
Stringhe "Tipo di campo" valide | Dimensione sovrascritta | Scala sovrascritta | Conversione in "Tipo di campo" valido |
---|---|---|---|
Bool | automatico | logico | |
Byte | automatico | ||
Int16 | automatico | ||
Int32 | automatico | intero | |
Int 64 | automatico | ||
FixedDecimal | manuale | manuale | |
Float | automatico | ||
Doppio | automatico | numerico | |
Stringa | manuale | ||
WString | manuale | ||
V_String | |||
V_WString | fattore; carattere | ||
Data | automatico | ||
Ora | automatico | ||
Data e ora | automatico | ||
Blob | |||
Oggetto spaziale |
source
: popola questa colonna facoltativa con una stringa che descrive le origini della colonna.
description
: popola questa colonna facoltativa con una stringa descrittiva.
write.AlteryxGraphMetaInfo
: questa funzione imposta le meta informazioni dell'output denominato sul grafico di uno script R con
AlteryxGraph()
. Non puoi utilizzare questa funzione se
AlteryxFullUpdate = FALSE
.
Parametri facoltativi
nOutput
: specifica l'output in cui desideri aggiungere i metadati della colonna.