How to Create a Custom JavaScript Text Variable

Introduction

This article describes how to create your own custom JavaScript text variable. 

Requirements

• A Displayr document. 

Method

1. Either hover over any variable in your Data Sets tree > Plus (+) > Insert Variable(s) > Custom Code > JavaScript - Text, or else from the toolbar menu, select Anything > Data > Variables > New > Custom Code > JavaScript - Text. 

2. Enter your JavaScript code into the JAVASCRIPT CODE section in the object inspector on the right.  

3. Click the Calculate button to run the code and create the JavaScript variable. 

By default, a new variable will be added to the top of your Data Sets tree on the left. Note, if you first select a variable in your Data Sets tree, the R variable will be added directly after that. Additionally, if you have multiple data sets in your document, you should first select the appropriate Data Sets tree you wish to add the variable to.

4. Update Name and Label as appropriate.

5. OPTIONAL: If you wish to change your variable to categorical, set Structure to Nominal. This will then use the text results as category labels.

6. OPTIONAL: Tick Access all data rows if you wish to work with arrays. The result must also be an array.

7. OPTIONAL: Tick Accelerate (skip logic checks) to run your variable faster, particularly when your code is simple. In this case, you must first ensure you initialize all local variables before use. For example, write var sum = 0; instead of var sum;.

See Also

How to Work with JavaScript in Displayr