Best Practices on Working with R Transform in Panopticon

When applying a transform with R in Panopticon for small and simple cases, you have the option of typing or pasting the code directly into the Transforms window. However, when you have several different transforms, or when each transform is applied in several data tables, it is highly recommended to follow the steps outlined below on how to apply functional programming and the D.R.Y. principle (Don’t Repeat Yourself) to the R transforms in Panopticon.

Steps:

1.     Save your code in R-files for R. This option gives you the freedom to work on the code in RStudio.

2.     Instead of using an imperative coding approach, define one or several functions in the file, which when invoked, runs your code, takes a data frame as an input argument, and then returns the resulting data frame.

3.     In the Transforms window of Panopticon, reference this external code file at the very top:

source("path/to/your/folder/your_R_file.R")

You can then invoke (call) any function that you have defined in your code file with a function call in the transform code window. Ideally, the function will return the transformed data frame.

4.     The path to the external code file needs to be valid both from the point of view of  Panopticon Designer on your local workstation, and from the point of view of Panopticon Real Timeyou publish to. This can be assured by introducing a global parameter in the Panopticon Real Time under the Parameters tab.

For example, you can name the parameter R_code_path and define its value as the full path to the folder that contains your code files. Next, on Panopticon Real Time, define a global parameter with the same name, but with a value that is the path to the server-side folder containing your code files. Copy the code files to the server-side folder then edit the path specified in your sourcing call in the transform so that it contains the parameter. For example:

source(file.path("{R_code_path}", "your_R_file.R"))

This will achieve a path reference to your code file which is valid in both the Designer and Server. It is also useful when promoting or migrating a Panopticon workbook from one server environment to another.