{"id":42936,"date":"2018-12-07T09:32:24","date_gmt":"2018-12-07T01:32:24","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=42936"},"modified":"2024-07-09T10:39:57","modified_gmt":"2024-07-09T02:39:57","slug":"r-language","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/sentinel\/sentinel-studio\/component-logic-functions\/r-language\/","title":{"rendered":"R Script"},"content":{"rendered":"\n

This article applies to IFS OI Explorer version 4.5.4 and later, and IFS OI Sentinel 4.1.3 and later.<\/p>\n

R is an open source programming language and software environment for statistical computing and graphics that is supported by the R Foundation for Statistical Computing.<\/p>\n

The R Script component allows you to access R, as a way of analysing data within your process.<\/p>\n

Users of the R Code Block should already be familiar with the R Language and syntax, and should refer to the existing R documentation for further help.<\/p>\n

The R Script component sends input data to R for processing, using a defined R script. The resultant value declared by the \u2018output\u2019 symbol is sent to the \u2018out\u2019 output pin. Data which is sent to the input pins is set in R using the Input Symbol name. Each symbol is set to an R dataframe with 2 columns, \u2018value\u2019 and \u2018timestamp\u2019, where \u2018value\u2019 is the value of the datapoint and \u2018timestamp\u2019 is the timestamp of the datapoint. The format of the timestamp can be specified in the \u2018Timestamp Format\u2019 option.<\/p>\n

\"\"<\/p>\n

Once an R Script has finished executing, the Global Environment is cleared. This means that any state which is stored in the Global Environment is lost between each run of the script.<\/p>\n

For security reasons, the following R functions are not allowed to be used in Scripts: system, system2, shell, library, require, detach, install.packages, eval, source<\/em><\/strong>.<\/p>\n

Users who wish to use extra libraries, should contact their System Administrator to install the library into R and also add the library name to the RLibraries <\/em>configuration setting.<\/p>\n

\n

Properties<\/h2>\n

The R Script component has four properties: Name, R Input Symbols<\/strong>, Timestamp<\/strong> Format<\/strong>, and R Script<\/strong>.<\/p>\n

\"\"<\/a><\/p>\n

Name<\/p>\n

Give the R Script component a name, to differentiate it from other R Script components in the process.<\/p>\n

In our example, the Name<\/strong> is \u2018R1\u2019.<\/p>\n

R Input Symbols<\/p>\n

Use the R Input Symbols to add and name data inputs to the R Script. These can then be used in the R Script.<\/p>\n

\"\"<\/a><\/p>\n

In our example, we\u2019ve added \u2018First\u2019 and \u2018Second\u2019 as the R Input Symbols<\/strong>. As they are added as properties, they are assigned as inputs to the component.<\/p>\n

Timestamp Format<\/p>\n

To pass the timestamps of the data points as text, supply a formatting string here. For example, dd\/M\/yyyy H:mm:s<\/p>\n

For details on the format string syntax, please refer to: https:\/\/docs.microsoft.com\/en-us\/dotnet\/standard\/base-types\/custom-date-and-time-format-strings<\/a>.<\/p>\n

If you require the data points to have timestamps passed to R as numeric Posix time (number of seconds since 1\/1\/1970 at 00:00 UTC), leave the format string blank.<\/p>\n

R Script<\/p>\n

The R Script should use the R Input Symbols in a script that uses the R Language. You can type the R Script in, or you can load it from an R file that is stored in a file directory.<\/p>\n

In our example, the R Script is: \u2018output <- First$value + Second$value\u2019. Note that R Language syntax is used here.<\/p>\n