R Module Overview

Overview

The R Module allows a user to execute R scripts. R is a programming language that is used for statistical computing and graphics. 

Prerequisites

ProjectHub

A dependency must be made with the R module before any of the module's functionality can be accessed within a Project. All scripts are kept within a folder under the Manage section: [Project Name] > Manage > Integrations > Scripting. 

Starting in v9.2 there is the ADD SCRIPT FOLDER action that will create new scripting folders within the primary R folder.

In v9.6 and above, script folders can be deleted by right-clicking the folder, then selecting Manage | More > Delete.

System Level

R scripts can also be created and stored at the System level. Projects will not be able to access these directly. However, Users can move the script folder and its scripts to a specific Project by right-clicking and selecting Manage | Move to Project.

Example

This example will demonstrate how to execute an R script.

1. Navigate to Settings > R Module Settings and enter the path where R is installed. Then, click SAVE.
   
2. Navigate to [Project Name] > Manage > Integrations > Scripting. Right-click on R Script Projects and select Add Script Project.
3. Name the Script Project (R Test Script) and click SAVE.
4. Right-click on the R Script Project and select Add Script.
5. Name the Script (R Example Script) and upload a valid R file. Then, click SAVE.
6. Inside the same Project, Click CREATE FLOW on the Global Action Bar and select Flow. Name the Flow (R Module Flow) and click CREATE.
7. Click on the Done path of the Start step. Navigate to Integrations > All Integrations > R > R Test Script. Select Example R Script step and click ADD.
8. Connect the Success and Error paths to the End step. Then, click Save to save changes to the Flow. 

Debug

1. On the top action bar, click Debug. Then, click START DEBUGGING.
2. After the debugger runs, click on the script step, click Execution 1, and select View Output Data. The Output Data will display the execution of the R script.
   
   

Feature Changes