R-Tool
R-Tool
Wichtig
Die Aktualisierung für Prognose-Tools 2022.1 ist jetzt verfügbar und enthält R 4.1.3. Installieren Sie die Aktualisierung, um neue R-Pakete von CRAN in Ihrem benutzerdefinierten Code zu verwenden. Sie benötigen diese Aktualisierung nicht, wenn Ihr aktueller oder neuer R-Code bereits installierte Pakete verwendet.
Das R-Tool ist ein Code-Editor für R-Benutzer. R ist eine Open-Source-Codebasis, die Sie für statistische Analysen verwenden können. Sie sollten R-Kenntnisse besitzen, bevor Sie dieses Tool verwenden.
R in Designer
Designer liest gültige R-Skripte ein und leitet diese über das Tool weiter. Die Ausgabe des R-Tools stimmt mit den Ausgaben in R überein.
R-Unterstützung
Obwohl Designer benutzerdefinierten R-Code akzeptiert, bietet Alteryx keine Unterstützung für benutzerdefinierten R-Code.
Alteryx verwendet
[AlteryxFullUpdate]
, eine globale Variable für das R-Skript, zur Aktualisierung der Metainformationen. Vollständige Aktualisierungen der Metainformationen erfolgen, wenn Sie
AlteryxFullUpdate
auf
TRUE
setzen. Dies geschieht, wenn Sie den Workflow zum ersten Mal öffnen oder ihn mit der F5-Taste aktualisieren.
Sie können keine Standard-Lese- und -Schreibfunktionen verwenden, wenn
AlteryxFullUpdate = TRUE
ist. Ein Fehler tritt auf, wenn ein R-Skript eine Funktion wie
read.Alteryx
oder
write.Alteryx
enthält, während
AlteryxFullUpdate = TRUE
ist.
Die Metainformationen, die Sie an die Ausgaben übergeben, wenn
AlteryxFullUpdate = TRUE
ist, können sich von den Metainformationen unterscheiden, die Designer erzeugt, wenn Sie den Workflow ausführen. Dies kann zu Fehlern führen.
Tool-Konfiguration
Das R-Tool akzeptiert mehrere Eingaben und kennzeichnet sie in der Reihenfolge ihrer Verbindung ( #1 , #2 usw.). Das Tool gibt bis zu fünf Datenströme aus den Ankern aus, die mit 1 bis 5 gekennzeichnet sind. Die Verweise im Code sollten den gleichen Formatunterschieden zwischen Ein- und Ausgaben folgen.
Wichtig
In den folgenden Beschreibungen bezieht sich
#1
auf alle Eingabe-Verbindungskennzeichen und
5
auf alle Ausgabe-Anker.
Das R-Tool verwendet die Funktion
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5)
für die Ausgabe.
Code einfügen : Führt Designer-spezifische Befehle auf, die Sie in den R-Code-Editor einfügen können. Verwenden Sie für diese Befehle die typischen R-Befehle. Die Liste ist nicht umfassend.
R- und Schnittstellen-Tools
: Um auf die Schnittstellen-Tools im R-Tool zuzugreifen, geben Sie
%Question.tool_name%
ein, wobei
tool_name
der Name des Schnittstellen-Tools ist. Sie finden diesen auf der Registerkarte
Anmerkung
im Fenster
Konfiguration
.
Eingabe lesen
Eingabe lesen
: Diese Funktion liest eine verbundene Dateneingabe ein. Jede verbundene Eingabe erstellt eine separate Option, die in der Reihenfolge der Verbindung aufgelistet wird. Wählen Sie eine aufgelistete Eingabe aus, um die Verbindung in den Code-Editor einzufügen. Sie können diese Funktion unabhängig davon verwenden, ob Sie
AlteryxFullUpdate
auf
TRUE
oder
FALSE
setzen.
The
read.Alteryx()
-Funktion streamt Eingabedaten in die R-Umgebung.
Optionale Parameter
Zeilennamen
: Ein optionaler Parameter zur Aufnahme einer neuen Spalte mit dem Namen „Zeilennamen" (RowNames), die mit der ersten Spalte von Daten gefüllt wird, die als Kopfzeilen behandelt werden sollen. Standardmäßig legt Designer diesen Parameter auf
FALSE
fest.
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, TRUE)
Als Datenrahmen : Diese Option liest eine Datentabelle ein. Hier gibt es keine anderen Parameter.
read.Alteryx("#1", mode="data.frame")
Als Datenrahmen: Aufgeteilt : Diese Option liest eine große Datentabelle ein. Geben Sie die Anzahl der Datensätze an, die gleichzeitig verarbeitet werden sollen.
read.Alteryx("#1", 50000, mode="data.frame")
Als Liste : Diese Option liest Geo-Objekte ein.
read.Alteryx("#1", mode="list")
Als Liste: Chunked : Diese Option liest eine große Anzahl von Geo-Datensätzen ein. Geben Sie die Anzahl der Datensätze an, die gleichzeitig verarbeitet werden sollen.
read.Alteryx("#1", 50000, mode="list")
Eingabe MetaInfo : Diese Option liest die Metainformationen aus der Eingabe und nicht aus Daten. Die Funktion gibt einen Datenrahmen zurück, der die Metainformationen beinhaltet. Die Zeilen des Datenrahmens stellen die einzelnen Spalten der Eingabedaten dar, während die entsprechenden Metainformationen in sechs Spalten angezeigt werden:
Name : Zeichenfolge, der Spaltenname.
Typ : Zeichenfolge, der Datentyp.
Größe : Ganzzahl, die Größe der Datentypen in Bytes.
Skala : Ganzzahl, die Anzahl der Dezimalstellen bei „Festen Nachkommastellen“ (FixedDecimal).
Quelle : Zeichenfolge, die Metadaten zum Spaltentyp, gefolgt von einem Startwert.
Beschreibung : Zeichenfolge, eine optionale Spalte, die mit einer Beschreibung ausgefüllt werden kann.
read.AlteryxMetaInfo("#1")
Fortschritt festlegen
Fortschritt festlegen : Diese Funktion meldet den Fortschritt über das Tool-Symbol in einem Workflow. Wählen Sie eine dieser Inkrement-Optionen aus:
25%
50%
75%
100%
AlteryxProgress(0.25)
Ausgabemeldung
Ausgabemeldung : Diese Funktion zeigt eine Meldung im Ergebnisfenster an. Die Meldungspriorität bestimmt, wann Designer die Meldung anzeigt. Wie Meldungen angezeigt werden, können Sie in der Workflow-Konfiguration ändern.
Meldungspriorität
Normale Priorität - Meldung : Die Meldung wird nur angezeigt, wenn das R-Tool auf dem Canvas des laufenden Workflows sichtbar ist. Wenn das R-Tool in einem Makro enthalten ist, zeigt Designer die Meldung nicht an.
AlteryxMessage("message", msg.consts$INFO, priority.consts$LOW)
Normale Priorität - Vorübergehende Meldung : Die Meldung wird anstelle einer vorhandenen Meldung angezeigt, die vom gleichen Tool ausgegeben wird.
AlteryxMessage("message", msg.consts$INFO, priority.consts$LOW, 5)
Mittlere Priorität - Warnung : Die Meldung wird angezeigt, wenn das R-Tool auf dem Canvas des laufenden Workflows sichtbar bzw. in einem Makro des laufenden Workflows enthalten ist.
AlteryxMessage("message", msg.consts$WARNING, priority.consts$MEDIUM)
Feldkonvertierungsfehler : Die Meldung wird angezeigt, wenn Sie Daten nicht von einem Feldtyp in einen anderen konvertieren können oder wenn die Daten nicht mit der Feldspezifikation übereinstimmen.
AlteryxMessage("message", msg.consts$FIELD_CONVERSION_ERROR)
Hohe Priorität - Fehler : Die Meldung wird unabhängig von der Beziehung des R-Tools zum laufenden Workflow angezeigt. Designer stuft Fehler bei der Feldkonvertierung als hohe Priorität ein.
AlteryxMessage("message", msg.consts$ERROR, priority.consts$HIGH)
Ausgabe schreiben
Ausgabe schreiben : Diese Option gibt einen Datenstrom von einem Ausgabeanker aus. Alle Anker können entweder Daten oder ein einzelnes Diagramm erzeugen.
Datenrahmen
Es empfiehlt sich, Daten mit der R-Funktion
data.frame()
in einen Datenrahmen zu konvertieren, bevor Sie die Funktion
write.Alteryx()
verwenden. Wenn die Daten nicht in einen Datenrahmen konvertiert sind, versucht Alteryx, sie in einen Datenrahmen zu konvertieren, was aber möglicherweise nicht wie erwartet funktioniert.
Optionale Parameter
Quelle : Dieser optionale Parameter fügt der Spalte Quelle in der Metadatenausgabe eine Zeichenfolge hinzu.
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, source="customer data from 2012 repo")
Zeilennamen : Dieser optionale Parameter enthält eine neue Spalte mit dem Namen „Zeilennamen" (RowNames) ein, die mit den Daten der ersten Spalte als Kopfzeilen befüllt werden. Der Standardwert für diesen Parameter ist FALSE .
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, TRUE)
Abhängigkeiten verpacken
Zusätzliche Dateien, die Ihren R-Code begleiten, werden von Designer nicht automatisch als Workflow-Abhängigkeiten erkannt. Falls Sie Ihren Workflow packen müssen und Ihr R-Code eigene Abhängigkeiten besitzt, fügen Sie alle zusätzlichen Dateien über die Tool-Konfiguration im Konfigurationsfenster hinzu.
Diagramm erstellen
Diagramm erstellen : Diese Option gibt ein Diagramm der Analyse aus. Designer behandelt die Ausgabe als Berichtsausschnitt, den Tools zur Berichterstellung einlesen können. Wählen Sie eine der folgenden Optionen für die Diagrammgröße aus:
6x6 Zoll - 96 dpi
8x10 Zoll - 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())
Aktualisierung/Metainformationen
If(AlteryxFullUpdate)... : Diese Funktion nutzt die globale Variable [AlteryxFullUpdate].
write.AlteryxAddFieldMetaInfo
: Diese Funktion fügt die Metainformationen einer einzelnen Spalte zur genannten Ausgabe hinzu. Sie können diese Funktion bei der Einstellung
AlteryxFullUpdate = FALSE
nicht verwenden.
Optionale Parameter
Sie können eine beliebige Kombination der folgenden Parameter verwenden.
nOutput
: Fügt Metadaten für eine Spalte der Ausgabe hinzu.
Name
: Geben Sie den Namen der Spalte an, die Sie ausgeben möchten. Wenn Sie einen ungültigen Namen angeben, tritt ein Fehler auf.
fieldType
: Stellt den Datentyp einer Spalte dar. Wenn Sie einen ungültigen Feldtyp angeben, tritt ein Fehler auf. Möglicherweise müssen Sie
Größe
und
Skala
basierend auf dem Feldtyp manuell aktualisieren. Designer akzeptiert verschiedene Feldtypen, indem sie in gültige Feldtypen konvertiert werden.
Größe
: Geben Sie die Größe der Spalte an. Designer weist diesen Wert automatisch vielen Feldtypen zu.
Skala
: Anzahl der Dezimalstellen der Spaltenwerte. Designer erfordert, dass Sie diesen Wert für Felder vom Typ
FixedDecimal
angeben, jedoch nicht für andere Feldtypen.
Gültige Feldtyp-Zeichenfolgen | Größe überschrieben | Skala überschrieben | Konvertiert in einen gültigen Feldtyp |
|---|---|---|---|
Bool | automatisch | logisch | |
Byte | automatisch | ||
Int16 | automatisch | ||
Int32 | automatisch | Ganzzahl | |
Int 64 | automatisch | ||
Festkommazahl | manuell | manuell | |
Gleitkomma | automatisch | ||
Double | automatisch | numerisch | |
Zeichenfolge | manuell | ||
WString | manuell | ||
V_String | |||
V_WString | Faktor; Zeichen | ||
Datum | automatisch | ||
Uhrzeit | automatisch | ||
Datum/Uhrzeit | automatisch | ||
Blob | |||
Geo-Objekt |
Quelle
: Füllen Sie diese optionale Spalte mit einer Zeichenfolge aus, die den Ursprung der Spalte beschreibt.
Beschreibung
: Füllen Sie diese optionale Spalte mit einer Beschreibung aus.
write.AlteryxGraphMetaInfo
: Diese Funktion legt die Metainformationen der benannten Ausgabe auf ein R-Skript-Diagramm mit
AlteryxGraph()
fest. Sie können diese Funktion bei der Einstellung
AlteryxFullUpdate = FALSE
nicht verwenden.
Optionale Parameter
nOutput
: Geben Sie die Ausgabe an, in der Sie die Metadaten der Spalte hinzufügen möchten.