User Variables

Menu Option: Analysis: User Variables
See also: Analysis View , Key Assumptions, Indicators, Variable Categories, Tags

In addition to the many variables defined by LEAP, you can also create up to 400 of your own User Variables.  A User Variable will be added as a tab in the data entry screens of the Analysis View.  You can specify data for user variables in Current Accounts and scenarios.  User Variables are currently available for use in your own intermediate calculations of the Analysis View. They cannot currently be reported in the Result Views. However, you may refer to these variables just as you would any other variables in the Analysis View, and the values of user variables can be specified using all of the same expressions available to other LEAP variables.

You can use the Analysis: User Variables screen to view and edit all User Variables.  Alternatively, you can right-click on one of the User Variable tabs in the Analysis View to Add (), Delete (), and edit () a User Variable or to make a new variable as a Duplicate copy of an existing one.

Each user-defined variable has the following information associated with it:

Basic Information

  • Name: The label that appears on the Analysis View tab associated with the variable.

  • Scale/Units:  The scaling factor and units in which the variable is measured.  Note that these data are for information only.  The unit is entered as text.

  • Category: Use this box to assign a variable to a particular category.  LEAP has a number of default categories (basic variables, cost variables, environmental variables, etc.).  You can also add your own variable categories using the Analysis: Variables: Variable Categories screen.  This screen is also accessible from the toolbar in the User Variables screen.

  • Notes: a longer description of the variable, that will be displayed in a panel whenever the variable is being edited.

  • Time-Sliced Variable: Use this check box to indicate if a user variable is to be specified with sub annual data (e.g. seasonal or time-of-day values). Use the General: Time Slices screen to view or edit the time slices into which each year is divided.

  • Intermediate Variable: You can optionally mark a user variable as an Intermediate variable (i.e. one that has been created primarily to contain intermediate calculations but would be of lesser interest to non-modelers).  In the Analysis View screen you can right-click on the variable tabs and choose to display  All User Variables,  No Intermediate Variables or None (No User Variables).

Defaults

  • Default Expressions:  You can set default expressions for user variables for both Current Accounts and scenarios.  Default expressions can be simple values or they can be complex expressions that utilize the functions and variable references. If the scenario default expression is left blank, the default will be the same as for Current Accounts (based on LEAP's standard expression inheritance).

  • Read-Only: Use this check box to indicate if a user variable is editable by the user in the Analysis View. You may want to set variables that are always calculated using the same default expression as read only.

Visibility

  • Scenario Visibility: Use the Current Accounts and Scenario check boxes to set whether a user variable is visible in Current Accounts and scenarios.  If unchecked, the variable (tab) will not appear in the Analysis view.  You can uncheck both boxes to temporarily hide a user variable. Note that hiding a user variable does not delete any of its data.  

  • Tag Visibility: You can add tags to limit the visibility of user variables to only those branches containing one or more of the listed tags.  If blank, the user variable will be visible at any branch (whether it is tagged or not).  

    Tags should be typed in separated by commas, or you can add an existing tag by pressing the Tag button and selecting the Add button, or delete a tag using the Delete button. You can organize your tags into color coded groups using the Manage Tags option (), which can also be accessed from the Tags menu  on the main screen (Alt+T).

  • Branch Visibility:  You can set the types of tree branches at which each user variable is available: All branches or Demand branches (all, technologies or categories), Transformation branches (all, modules, processes or outputs), Environment, Resources, Statistical Differences, Stock Changes, Non-energy sector effects, and Indicators.  

  • Available On & Below Branch: You can also select the tree branches where the user variable will appear.  So for example, you might choose to show a user variable at all technology branches on and below the Transport sector branch.  Use the check boxes to select if a variable is visible on and/or below the selected branch.  You can also specify if a variable is only visible at a certain specified number of levels below the named branch.  For example some user variables may be visible one level below the named branch, while others might be visible at all levels below the named branch.

Min/Max

  • Min/Max Values:  You can set minimum and maximum allowable values for user variables.  LEAP's data will later be tested to ensure these values remain within the specified minimum and maximum constraints.  Leave fields blank if you do not want to specify minimum or maximum values.

Note: In addition to defining your own User Variables you can also create variables under the Key Assumptions and Indicators categories on the tree,.