Outil R
Outil R
Important
La mise à jour 2022.1 des outils Prédictif est désormais disponible et inclut R 4.1.3. Installez la mise à jour pour utiliser les nouveaux packages R de CRAN dans votre code personnalisé. Il n'est toutefois pas nécessaire de l'installer si votre code R actuel ou votre nouveau code R utilise des packages déjà installés.
L'outil R est un éditeur de code destiné aux utilisateurs de R. R est un code base open source que vous pouvez utiliser à des fins d'analyse statistique. Vous devez maîtriser le langage R avant d'utiliser cet outil.
R dans Designer
Designer lit dans les scripts R valides et les transmet via l'outil. La sortie de l'outil R correspond à la sortie dans R.
Prise en charge R
Bien que Designer prenne en charge le code R personnalisé, ce n'est pas le cas d'Alteryx.
Alteryx utilise
[AlteryxFullUpdate]
, une variable globale du script R, pour les mises à jour des méta-infos. Les mises à jour complètes des méta-infos se produisent lorsque la variable
AlteryxFullUpdate
est définie sur
TRUE
. C'est notamment le cas la première fois que vous ouvrez le workflow ou que vous l'actualisez avec la touche F5.
Vous ne pouvez pas utiliser les fonctions de lecture et d'écriture standard lorsque
AlteryxFullUpdate = TRUE
. Si un script R contient une fonction telle que
read.Alteryx
ou
write.Alteryx
alors que
AlteryxFullUpdate = TRUE
, une erreur se produit.
Les méta-infos que vous transmettez aux sorties lorsque
AlteryxFullUpdate = TRUE
peuvent différer de celles que Designer génère lorsque vous exécutez le workflow. Cela peut produire des erreurs.
Configuration de l'outil
L'outil R accepte plusieurs entrées et les identifie par ordre de connexion ( #1 , #2 , etc.). L'outil génère jusqu'à 5 flux de données à partir de ses ancrages, étiquetés de 1 à 5 . Les références dans le code doivent suivre les mêmes différences de format entre les entrées et les sorties.
Important
Dans les descriptions suivantes,
#1
désigne une étiquette de connexion d'entrée et
5
un ancrage de sortie.
L'outil R utilise la fonction
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5)
pour la sortie.
Insérer le code : dressez la liste des commandes propres à Designer que vous pouvez injecter dans l'éditeur de code R. Vous devez utiliser ces commandes avec des commandes R standard. Cette liste n'est pas exhaustive.
R et outils Interface
: pour accéder aux outils Interface de l'outil R, saisissez
%Question.tool_name%
, où
tool_name
correspond au nom de l'outil Interface, que vous trouverez dans l'onglet
Annotation
de la fenêtre
Configuration
.
Lire l'entrée
Lire l'entrée
: cette fonction lit une entrée de données connectée. Chaque entrée connectée crée une option séparée répertoriée dans l’ordre de connexion. Sélectionnez une entrée dans la liste pour insérer la connexion dans l'éditeur de code. Vous pouvez utiliser cette fonction, que vous ayez défini
AlteryxFullUpdate
sur
TRUE
ou
FALSE
.
La fonction read.Alteryx() transfère les données d’entrée dans l’environnement R.
Paramètre facultatif
Noms des lignes
: paramètre facultatif pour inclure une nouvelle colonne intitulée RowNames, remplie avec la première colonne de données à traiter en tant qu'en-tête de ligne. Par défaut, Designer définit ce paramètre sur
FALSE
.
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, TRUE)
en tant que trame de données : cette option lit une table de données. Aucun autre paramètre n'est disponible.
read.Alteryx("#1", mode="data.frame")
en tant que trame de données : en bloc : cette option lit dans une table de données volumineuse. Indiquez le nombre d'enregistrements à traiter simultanément.
read.Alteryx("#1", 50000, mode="data.frame")
en tant que liste : cette option lit les objets spatiaux.
read.Alteryx("#1", mode="list")
en tant que liste : en bloc : cette option lit un grand nombre d'enregistrements spatiaux. Indiquez le nombre d'enregistrements à traiter à un moment donné.
read.Alteryx("#1", 50000, mode="list")
Entrée Méta-infos : cette option lit les métas-infos à partir de l'entrée plutôt que des données. La fonction renvoie une trame de données comportant les méta-infos. Les lignes de la trame de données représentent chaque colonne à partir des données d'entrée, tandis que les méta-infos applicables s'affichent dans six colonnes :
Nom : chaîne, nom de la colonne.
Type : chaîne, type de données.
Taille : nombre entier, taille du type de données (en octets).
Échelle : nombre entier, nombre de décimales dans FixedDecimal.
Source : chaîne, métadonnées relatives au type de colonne, suivies de la valeur de départ.
Description : chaîne, colonne facultative que vous pouvez remplir avec une chaîne de description.
read.AlteryxMetaInfo("#1")
Définir la progression
Définir la progression : cette fonction indique la progression sur l'icône de l'outil dans un workflow. Sélectionnez l'une des options d'incrémentation suivantes :
25%
50%
75%
100%
AlteryxProgress(0.25)
Message de sortie
Message de sortie : cette fonction affiche un message dans la fenêtre Résultats . La priorité du message détermine le moment où Designer signale le message. Accédez à la section Configuration du workflow pour changer le comportement d'affichage des messages.
Priorité du message
Message de priorité normale : le message ne s'affiche que lorsque l'outil R est visible sur le canevas du workflow en cours d'exécution. Si l'outil R est contenu dans une macro, Designer n'affiche pas le message.
AlteryxMessage("message", msg.consts$INFO, priority.consts$LOW)
Message provisoire de priorité normale : le message s'affiche à la place d'un message existant que le même outil génère.
AlteryxMessage("message", msg.consts$INFO, priority.consts$LOW, 5)
Avertissement de priorité moyenne : le message s'affiche lorsque l'outil R est visible sur le canevas du workflow en cours d'exécution ou est contenu dans une macro dans un workflow en cours d'exécution.
AlteryxMessage("message", msg.consts$WARNING, priority.consts$MEDIUM)
Erreur de conversion de champ : le message s'affiche lorsque vous ne pouvez pas convertir les données d'un type de champ en un autre ou lorsque les données ne correspondent pas à la spécification de champ.
AlteryxMessage("message", msg.consts$FIELD_CONVERSION_ERROR)
Erreur de haute priorité : le message s'affiche quelle que soit la relation entre l'outil R et le workflow en cours d'exécution. Designer traite les erreurs de conversion de champ comme erreurs de haute priorité.
AlteryxMessage("message", msg.consts$ERROR, priority.consts$HIGH)
Écrire la sortie
Écrire la sortie : cette option génère un flux de données à partir d'un ancrage de sortie. Tous les ancrages peuvent produire des données ou un graphique unique.
Trame de données
Il est recommandé de convertir les données en trame de données avec la fonction R
data.frame()
avant d'utiliser la fonction
write.Alteryx()
. Si les données ne sont pas converties en trame de données, Alteryx tente de convertir en trame de données, bien que cela risque de ne pas fonctionner comme prévu.
Paramètres facultatifs
Source : ce paramètre facultatif permet d'ajouter une chaîne à la colonne Source dans la sortie des métadonnées.
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, source="customer data from 2012 repo")
Noms des lignes : ce paramètre facultatif permet d'inclure une nouvelle colonne intitulée RowNames, remplie avec la première colonne de données en tant qu'en-tête de ligne. Ce paramètre est par défaut défini sur FALSE .
write.Alteryx(DATA_VARIABLE_TO_WRITE, 5, TRUE)
Dépendances de la création de packages
Designer ne détecte pas automatiquement les fichiers supplémentaires qui accompagnent votre code R en tant que dépendances du workflow. Si vous souhaitez créer un package du workflow et que votre code R possède ses propres dépendances, veillez à inclure les fichiers supplémentaires à l'aide de la configuration de l'outil de la fenêtre Configuration .
Créer un graphique
Créer un graphique : cette option génère un graphique de l'analyse. Designer traite la sortie comme un extrait de rapport que les outils de la catégorie Génération de rapports peuvent lire. Sélectionnez l'une des options suivantes pour la taille du graphique :
6x6 pouces - 96 dpi
8x10 pouces - 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())
Mettre à jour/Méta-infos
if(AlteryxFullUpdate)... : cette fonction fonctionne avec la variable globale [AlteryxFullUpdate].
write.AlteryxAddFieldMetaInfo
: cette fonction ajoute les méta-infos d'une seule colonne à la sortie désignée. Vous ne pouvez pas utiliser cette fonction lorsque
AlteryxFullUpdate = FALSE
.
Paramètres facultatifs
Vous pouvez utiliser n'importe quelle combinaison des paramètres ci-dessous.
nOutput
: ajoute des métadonnées pour une colonne à la sortie.
name
: spécifiez le nom de la colonne à générer. Si vous indiquez un nom incorrect, une erreur se produit.
fieldType
: représente le type de données d'une colonne. Si vous indiquez un type de champ non valide, une erreur se produit. Il est possible que vous deviez mettre à jour manuellement la
taille
et
l'échelle
en fonction du type de champ. Designer prend en charge plusieurs types de champs en les convertissant en types de champs valides.
size
: spécifiez la taille de la colonne. Designer affecte automatiquement cette valeur à de nombreux types de champs.
scale
: spécifiez le nombre de décimales pour les valeurs de colonne. Designer exige que vous spécifiiez cette valeur pour les types de champs
FixedDecimal
, mais pas pour les autres types de champs.
Chaînes type de champ valides | Remplacement de la taille | Remplacement de l'échelle | Conversion en un type de champ valide |
|---|---|---|---|
Bool | automatique | logique | |
Byte | automatique | ||
Int16 | automatique | ||
Int32 | automatique | Nombre entier | |
Int 64 | automatique | ||
FixedDecimal | Manuel | Manuel | |
Float | automatique | ||
Double | automatique | numérique | |
Chaîne | Manuel | ||
WString | Manuel | ||
V_String | |||
V_WString | facteur ; caractère | ||
Date | automatique | ||
Time | automatique | ||
DateTime | automatique | ||
Blob | |||
Objet géographique |
source
: remplissez cette colonne facultative avec une chaîne décrivant les origines de la colonne.
description
: remplissez cette colonne facultative avec une chaîne de description.
write.AlteryxGraphMetaInfo
: cette fonction définit les méta-infos de la sortie nommée sur un graphique de script R avec
AlteryxGraph()
. Vous ne pouvez pas utiliser cette fonction lorsque
AlteryxFullUpdate = FALSE
.
Paramètres facultatifs
nOutput
: spécifiez la sortie dans laquelle vous souhaitez ajouter les métadonnées de la colonne.