Outil R
L'outil R est un éditeur de code pour les utilisateurs R. R est une base de code open-source que vous pouvez utiliser pour l'analyse statistique. Vous devez être compétent en R avant d'utiliser cet outil.
Compatibilité Alteryx Public Gallery
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
Le concepteur lit dans les scripts R valides et les transmet à travers l'outil. La sortie de l'outil R correspond à la sortie en R.
Support R
Bien que Designer accepte le code R client, Alteryx ne fournit pas de support pour le code R client.
Alteryx utilise [AlteryxFullUpdate], une variable globale pour le script R, pour les mises à jour de la microinfo. Les mises à jour méta-info complètes se produisent lorsque vous configurez AlteryxFullUpdate à VRAI. Cela se produit lorsque vous ouvrez le flux de travail ou le rafraîchissez avec la clé F5.
Vous ne pouvez pas utiliser les fonctions standard de lecture et d'écriture lorsque AlteryxFullUpdate - TRUE. Si un script R contient une fonction comme la lecture. Alteryx ou écrire. Alteryx tandis que AlteryxFullUpdate - VRAI, une erreur se produit.
Metainfo que vous passez aux sorties lorsque AlteryxFullUpdate - TRUE peut différer de metainfo Designer génère lorsque vous exécutez le flux de travail. Cela peut produire des erreurs.
Configurer l'outil
L’outil R accepte plusieurs entrées, et les étiquettes par ordre de connexion(#1, #2,et ainsi de suite.). L'outil produit jusqu'à cinq flux de données à partir de ses ancres, é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.
Dans les descriptions ci-dessous, #1 se réfère à n'importe quelle étiquette de connexion d'entrée et 5 se réfère à n'importe quelle ancre de sortie.
L'outil R utilise la fonction écrire. Alteryx (DATA-VARIABLE-TO-WRITE, 5) pour la sortie.
Insérez code: Liste Des commandes spécifiques au concepteur que vous pouvez injecter dans l'éditeur de code R. Vous devez utiliser ces commandes avec des commandes R typiques. La liste n'est pas complète.
R et outils d'interface: Pour accéder aux outils d'interface dans l'outil R, entrez %Question.tool-name% où l'outil est le nom de l'outil d'interface, que vous pouvez trouver sur l'onglet Annotation dans la fenêtre Configuration.
Lire l'entrée
Lire l'entrée: Cette fonction 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. Vous pouvez utiliser cette fonction, que vous puissiez définir AlteryxFullUpdate sur VRAI ou FALSE.
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, Designer définit ce paramètre sur FALSE.
écrire. Alteryx (DATA-VARIABLE-TO-WRITE, 5, VRAI)
sous forme de cadrede données : Cette option se lit dans un tableau de données. Il n'a pas d'autres paramètres.
lire. Alteryx ("#1", mode "data.frame")
sous le titre Data Frame: Chunked: Cette option se lit dans un grand tableau de données. Spécifiez le nombre d'enregistrements que vous souhaitez qu'il traite à la fois.
read.Alteryx("#1", 50000, mode="data.frame")
comme Liste: Cette option se lit dans les objets spatiaux.
read.Alteryx("#1", mode="list")
comme Liste: Chunked: Cette option se lit dans un grand nombre d'enregistrements spatiaux. Spécifiez le nombre d'enregistrements que vous souhaitez traiter à la fois.
read.Alteryx("#1", 50000, mode="list")
Entrée MetaInfo: Cette option se lit dans le métainfo à partir de l'entrée plutôt que des données. La fonction renvoie un dataframe qui contient le métainfo. Les lignes du dataframe représentent chaque colonne à partir des données d'entrée, tandis que les métainfos applicables s'affichent en six colonnes :
- Nom: chaîne, nom de colonne
- Type: chaîne, le type de données
- Taille: entier, la taille du type de données en octets
- Échelle: intégriste, le nombre de décimales dans un FixedDecimal
- Source: chaîne, les métadonnées sur le type de colonne, suivies de la valeur de départ
- Description: chaîne, une colonne facultative que vous pouvez remplir avec une chaîne de description
read.AlteryxMetaInfo("#1")
Définir la progression
Définir le progrès: Cette fonction signale les progrès réalisés sur l'icône de l'outil dans un flux de travail. Sélectionnez l'une de ces options d'augmentation :
- 25%
- 50%
- 75%
- 100%
AlteryxProgress(0.25)
Message de sortie
Messagede sortie : Cette fonction affiche un message dans la fenêtre Résultats. La priorité de message détermine quand Le concepteur signale le message. Voir la configuration workflow pour modifier le comportement d’affichage des messages.
Priorité de message
Message prioritaire normal: Le message ne s'affiche que lorsque l'outil R est visible sur la toile d'un flux de travail en cours d'exécution. Si l'outil R est contenu dans une macro, Le concepteur n'affiche pas le message.
AlteryxMessage("message", msg.consts$INFO, priority.consts$LOW)
Message transitoire prioritaire normal: Le message affiche à la place d'un message existant les mêmes problèmes d'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 flux de travail en cours d'exécution ou est contenu dans une macro dans le flux de travail en cours d'exécution.
AlteryxMessage("message", msg.consts$WARNING, priority.consts$MEDIUM)
Erreurde conversion de champ : Le message s'affiche lorsque vous ne pouvez pas convertir des données d'un type de champ à un autre ou lorsque les données ne s'inscrivent pas dans la spécification de champ.
AlteryxMessage("message", msg.consts$FIELD_CONVERSION_ERROR)
Erreur de priorité élevée: Le message s'affiche quelle que soit la relation de l'outil R avec le flux de travail en cours d'exécution. Designer traite les erreurs de conversion sur le terrain comme une priorité élevée.
AlteryxMessage("message", msg.consts$ERROR, priority.consts$HIGH)
Écrire la sortie
Ecrire la sortie: Cette option produit 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: Ce paramètre optionnel ajoute une chaîne à la colonne Source dans la sortie de métadonnées.
écrire. Alteryx (DATA-VARIABLE-TO-WRITE, 5, source "données clients de 2012 repo")
Nomsde lignes : Ce paramètre optionnel inclut une nouvelle colonne intitulée RowNames, peuplée de la première colonne de données en tant qu'en-têtes de ligne. Ce paramètre par défaut à FALSE.
écrire. Alteryx (DATA-VARIABLE-TO-WRITE, 5, VRAI)
Dépendances de la création de packages
Le concepteur ne détecte pas automatiquement les fichiers supplémentaires qui accompagnent votre code R en tant que dépendances de flux de travail. Si vous avez besoin d'emballer votre flux de travail et que votre code R a ses propres dépendances, incluez tous les fichiers supplémentaires utilisant la configuration de l'outil dans la fenêtre Configuration.
Créer un graphique
Créer graphique: Cette option produit un graphique de l'analyse. Designer traite la sortie comme un extrait de rapport que les outils de reporting peuvent lire. Sélectionnez l'une de ces options pour la taille du graphique :
- 15,24 x 15,24 cm - 96 dpi
- 20,32 x 25,40 cm - 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())
Mise à jour/Metainfo
if (AlteryxFullUpdate)...: Cette fonction fonctionne avec la variable globale [AlteryxFullUpdate].
écrire. AlteryxAddFieldMetaInfo: Cette fonction ajoute la métainfo d'une seule colonne à la sortie nommé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: Ajouter des métadonnées pour une colonne à la sortie.
nom: Spécifiez le nom de la colonne que vous souhaitez produire. Si vous fournissez un nom invalide, une erreur se produit.
fieldType: Représenter le type de données d'une colonne. Si vous fournissez un type de champ invalide, une erreur se produit. Vous devrez peut-être mettre à jour manuellement la taille et l'échelle en fonction du type de champ. Le concepteur accepte plusieurs types de champ en les convertissant en types de champ valides.
taille: Spécifiez la taille de la colonne. Designer attribue automatiquement cette valeur à de nombreux types de champs.
échelle: Spécifiez le nombre de décimales pour les valeurs de colonne. Designer exige que vous spécifiez cette valeur pour les types de champ FixedDecimal, mais pas d'autres types de champ.
| Chaînes FieldType valides | Taille écrasée | Échelle écrasée | Convertit en un FieldType valide |
|---|---|---|---|
| Bool | automatique | logique | |
| Byte (Octets) | automatique | ||
| Int16 | automatique | ||
| Int32 | automatique | Nombre entier | |
| Int 64 | automatique | ||
| FixedDecimal | manuelle | manuelle | |
| Float | automatique | ||
| Double | automatique | numérique | |
|
String (Chaîne) |
manuelle | ||
| WString | manuelle | ||
| V_String | |||
| « V_WString » | facteur ; caractère | ||
| Date | automatique | ||
| Temps | automatique | ||
| DateHeure | automatique | ||
| Blob | |||
| Objet géographique |
source: Remplissez cette colonne facultative d'une chaîne qui décrit les origines de la colonne.
description: Remplir cette colonne facultative d'une chaîne de description.
écrire. AlteryxGraphMetaInfo: Cette fonction définit la métainfo de la sortie nommée à un graphique R Script avec AlteryxGraph(). Vous ne pouvez pas utiliser cette fonction lorsque AlteryxFullUpdate - FALSE.
Paramètres facultatifs
nSortie: Spécifiez la sortie dans laquelle vous souhaitez ajouter les métadonnées de la colonne.