analysis_variables
  • 27 Jul 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

analysis_variables

  • Dark
    Light
  • PDF

Article summary

analysis_variables

usage: common - datatype: array

The analysis_variables attribute defines the array of variable objects that will be analyzed in the context of method and other Tag.script attributes. The variable objects can represent both collections and variables, categorical or numeric. When a collection is included in the analysis_variables array, all variables from the collection will be analyzed. The output of a Tag.script contains an array of results, with one result for each analysis_variable specified.

"analysis_variables": [
  { 
    //A numeric variable object
    "variable_type": "numeric", //Indicates that this is a numeric collection
    "collection": "ccc1" //"ccc1" is a valid numeric collection name in Tag.cortex
  },
  { 
    //A numeric variable object
    "variable_type": "numeric",
    "collection": "ccc2", //"ccc2" is a valid numeric collection name in Tag.cortex
    "variable": vvv1" //"vvv1" is a valid variable name in collection "ccc2"
  },
  { 
    //A categorical variable object
    "variable_type": "categorical", //Indicates that this is a categorical collection
    "collection": "ccc3" //"ccc3" is a valid categorical collection name in Tag.cortex
  },
  { 
    //A categorical variable object
    "variable_type": "categorical",
    "collection": "ccc4" //"ccc4" is a valid categorical collection name in Tag.cortex
    "variable": "vvv2" //"vvv2" is a valid variable name in collection "ccc4"
  },
  { 
    //A complex variable object - see the Variable Object Reference
    "variable_type": "tttt", //Where "tttt" is one of many possible variable_types
    ...
  },
  ...
]

Was this article helpful?

What's Next