Outil R

L’outil R est un éditeur de code destiné aux utilisateurs de R. Il s’agit d’une base de code open source qui permet d’effectuer des analyses statistiques et prédictives. La maîtrise des scripts R est recommandée avant d’utiliser cet outil.

Compatibilité de la galerie publique alteryx

Vous envisagez de publier votre workflow sur Gallery.alteryx.com? Vous devez d’abord demander une exemption. Cette restriction ne s’applique pas aux instances privées d’Alteryx Server et d’Alteryx Gallery.

R dans Designer

Designer lit dans un script R valide et passe le script à travers l’outil. La sortie de l’outil R correspond aux sorties R.

Support R

Alors que designer accepte le code R personnalisé, Alteryx ne lui fournit pas de prise en charge.

Alteryx utilise [AlteryxFullUpdate], une variable globale pour le script R, pour les mises à jour de la microinfo. Les mises à jour complètes des informations de la webinfo se produisent lorsque AlteryxFullUpdate = true. Cela se produit lorsque le workflow est ouvert pour la première fois et lorsqu’il est actualisé à l’aide de F5.

AlteryxFullUpdate = false pendant toutes les autres mises à jour, telles qu'un workflow en cours d'exécution ou une reconfiguration de l'outil. Pour forcer les mises à jour complètes après la modification d'un workflow, sélectionnez exécuter le script lorsqu'il est actualisé (F5). Les opérations de mise à jour ne peuvent pas être annulées une fois démarrées.

Les fonctions standard de lecture et d'écriture ne peuvent pas être utilisées lorsque AlteryxFullUpdate = true. Si des fonctions telles que Read. Alteryx ou écrire. Alteryx sont dans le script lorsque AlteryxFullUpdate = true, une erreur se produit.

Les informations transmises aux sorties lorsque AlteryxFullUpdate = false peuvent différer des informations générées lors de l'exécution du Workflow. Cela peut produire des erreurs.

Configurer l’outil

L'outil R accepte plusieurs entrées et les étiquette dans l'ordre de connexion comme #1, #2, etc. L'outil émet jusqu'à 5 flux de données à partir de ses ancrages, étiquetés 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.

Pour les descriptions suivantes, #1 fait référence à n'importe quelle étiquette de raccordement d'entrée et 5 se rapporte à n'importe quelle ancre de sortie.

Les sorties de l'outil R à l'aide de la fonction Write. Alteryx (dataVariableToWrite, 5).

Insérez le code: une liste de commandes spécifiques qui peuvent être injectées dans l'éditeur de code R. Les commandes sont destinées à être utilisées avec des commandes R typiques. Cette liste n’est pas exhaustive.Designer

R et outils d'interface

Pour accéder aux outils d'interface avec l'outil R, entrez % question. tool_name% où tool_name est le nom de l'outil d'interface, qui se trouve sous l'onglet annotation de la fenêtre de configuration

Lire l'entrée

Lecture entrée: fonction qui se lit dans 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 répertoriée pour insérer la connexion dans l'éditeur de code. Cette fonction peut être utilisée que la variable AlteryxFullUpdate ait la valeur Vrai ou Faux.

La lecture. La fonction Alteryx () diffuse les données d'entrée dans l'environnement R.

Paramètre facultatif

Noms de lignes: paramètre optionnel pour inclure une nouvelle colonne intitulée RowNames, remplie avec la première colonne de données à traiter comme en-têtes de ligne. Par défaut, ce paramètre est défini sur FALSE.

write.Alteryx(dataVariableToWrite, 5, TRUE)

comme framede données: option utilisée pour lire dans une table de données. Pas d’autres paramètres.

read.Alteryx("#1",mode="data.frame")

en tant que frame de données: chunked: option utilisée pour lire dans une grande table de données. Indiquer le nombre d’enregistrements traités à un moment donné.

read.Alteryx("#1", 50000, mode="data.frame")

As List: option utilisée pour lire dans les objets spatiaux.

read.Alteryx("#1", mode="list")

en tant que liste: chunked: option utilisée pour lire dans un grand nombre d'enregistrements spatiaux. Indiquer le nombre d’enregistrements traités à un moment donné.

read.Alteryx("#1", 50000, mode="list")

Informations d'entrée: option utilisée pour lire les informations de l'entrée plutôt que les données. La fonction renvoie une image Data. Frame contenant le MetaFrame. Les lignes du data.frame représentent chaque colonne à partir des données d’entrée, tandis que les méta-infos applicables sont affichées dans 6 colonnes :

Nom: String. Nom de la colonne.
Type: String. Type de données.
Size: Integer. Taille du type de données en octets.
Scale: Integer. Nombre de décimales dans un FixedDecimal.
Source: String. Métadonnées sur le type de colonne, suivies de la valeur de départ.
Description: String. Colonne facultative pouvant être remplie avec une chaîne de description.

read.AlteryxMetaInfo("#1")

Définir la progression

Définir Progression: fonction qui signale des progrès sur l'icône de l'outil dans un workflow en cours d'exécution. Sélectionnez l’une des options d’incrémentation :

25%
50%
75%
100%

AlteryxProgress(0.25)

Message de sortie

Messagede sortie: fonction affichant un message dans la fenêtre résultats. La priorité du message détermine le moment de son signalement. Voir Configuration du workflow pour modifier le comportement d'affichage du message.

Message prioritaire normal: le message s'affiche uniquement lorsque l'outil R est visible sur la toile du workflow en cours d'exécution. Si l’outil R est contenu dans une macro, le message ne s’affiche pas.

AlteryxMessage("message", msg.consts$INFO, priority.consts$LOW)

Message transitoire prioritaire normal: le message est affiché à la place d'un message existant émis par le même outil.

AlteryxMessage("message", msg.consts$INFO, priority.consts$LOW, 5)

Avertissement de priorité moyenne: le message s'affiche lorsque l'outil R est visible sur la toile du workflow en cours d'exécution ou est contenu dans une macro dans le workflow en cours d'exécution.

AlteryxMessage("message", msg.consts$WARNING, priority.consts$MEDIUM)

Erreur de conversion de champ: le message s'affiche lorsque les données ne peuvent pas être converties d'un type de champ à un autre ou lorsque les données ne peuvent pas entrer dans la spécification de champ.

AlteryxMessage("message", msg.consts$FIELD_CONVERSION_ERROR)

Erreur de priorité élevée: le message est affiché quelle que soit la relation de l'outil R avec le workflow en cours d'exécution. Les erreurs de conversion de champs sont traitées avec une priorité élevée.

AlteryxMessage("message", msg.consts$ERROR, priority.consts$HIGH)

Écrire la sortie

Ecrirela sortie: une option pour la sortie d'un flux de données à partir d'une ancre de sortie. Toutes les ancres peuvent produire des données ou un seul graphe.

Paramètres facultatifs

Source: paramètre facultatif pour ajouter une chaîne à la colonne source dans la sortie de métadonnées.

write.Alteryx(dataVariableToWrite, 5, source= « données clients provenant du répertoire 2012 »)

Nomsde lignes: paramètre optionnel pour inclure une nouvelle colonne intitulée RowNames, remplie avec la première colonne de données sous forme d'en-têtes de ligne. Par défaut, ce paramètre est défini sur FALSE.

write.Alteryx(dataVariableToWrite, 5, TRUE)

Créer un graphique

Create Graph: une option pour produire un graphique de l'analyse. La sortie est traitée comme un extrait de rapport qui peut être lu par les outils Génération de rapports. Sélectionnez l’une des options de tailles de graphique :

15,24 x 15,24 cm - 96 dpi
20,32 x 25,40 cm - 300 dpi

AlteryxGraph (5, Width = 576, hauteur = 576)xPoints   </->Plot (xPoints, yPoints)<x 4="">invisible (dev. OFF ())</x> </x>

Mettre à jour/Méta-infos

if (AlteryxFullUpdate)... : Fonction qui fonctionne avec la variable globale [AlteryxFullUpdate].

Écrire. AlteryxAddFieldMetaInfo: fonction qui ajoute les informations d'une seule colonne à la sortie nommée. Cette fonction ne peut pas être utilisée lorsque AlteryxFullUpdate = false.

Paramètres facultatifs

Toute combinaison des paramètres suivants peut être utilisée.

nOutput: sortie à laquelle les métadonnées de la colonne sont ajoutées.

nom: nom de la colonne dont la microinfo est sortie. Cette option vérifie que le nom fourni est valide sinon une erreur se produit.

FieldType: chaîne représentant le type de DataType de la colonne. Cette option vérifie que le champ fieldType fourni est valide sinon une erreur se produit. La taille et l’échelle peuvent nécessiter une mise à jour manuelle en fonction de fieldType. Plusieurs fieldTypes sont des entrées acceptées qui sont converties en types de champ valides.

taille: taille de la colonne.

De nombreux fieldTypes reçoivent une valeur automatiquement.

Echelle: nombre de décimales pour les valeurs de colonne.

Cette option est nécessaire pour les FixedDecimal fieldTypes, mais est ignorée pour tous les autres types de champs.

Chaînes FieldType valides	Taille écrasée	Échelle écrasée	Convertit en un FieldType valide
Bool	automatique		logique
Octets	automatique
Int16	automatique
Int32	automatique		Nombre entier
Int 64	automatique
FixedDecimal	manuelle	manuelle
Float	automatique
Double	automatique		numérique
Chaîne	manuelle
WString	manuelle
« V_String »
« V_WString »			facteur ; caractère
Date	automatique
Temps	automatique
DateHeure	automatique
Blob
Objet géographique

source: colonne facultative pouvant être remplie avec une chaîne décrivant les origines de la colonne.

description: colonne facultative pouvant être remplie avec une chaîne de description.

Écrire. AlteryxGraphMetaInfo: fonction qui définit les informations de la sortie nommée sur un graphe de script R en appelant la fonction AlteryxGraph (). Cette fonction ne peut pas être utilisée lorsque AlteryxFullUpdate = false.