IModelling.Median

Syntax

Median(Inputs: Array): Variant;

Parameters

Inputs. Variable.

Description

The Median method returns median for the specified variable.

Comments

If more than one variable is specified in Inputs, the median is calculated for corresponding variables points. For example, the median of the points of 2018 by all variables.

Variables in Inputs must be separated via comma.

A calculation period can be set for the method. To do this, use the IModelling.SetPeriod method, by specifying it at any place of input array.

To calculate the method without taking into account empty values, use the IgnoreMissing parameter by specifying it in any place of the input array. Available values of the parameter:

Example

Executing the example requires that the repository contains a modeling container with the MS identifier. This contains includes a model with the MODEL_D identifier that is calculated by the determinate equation method and contains more than one input variable.

Add links to the Metabase and Ms system assemblies.

Sub UserProc;
Var
    Mb: IMetabase;
    ModelSpace, ModelObj: IMetabaseObject;
    Transf: IMsFormulaTransform;
    Formula: IMsFormula;
    Model: IMsModel;
    Determ: IMsDeterministicTransform;
    TransVar: IMsFormulaTransformVariable;
    Slice: IMsFormulaTransformSlice;
    TermInfo: IMsFormulaTermInfo;
    Inp_1: String;
    Expr: IExpression;
Begin
    Mb := MetabaseClass.Active;
    ModelSpace := Mb.ItemById("MS").Bind;
    ModelObj := Mb.ItemByIdNamespace("MODEL_D", ModelSpace.Key).Edit;
    Model := ModelObj As IMsModel;
    Transf := Model.Transform;
    Formula := Transf.FormulaItem(0);
    Determ := Formula.Method As IMsDeterministicTransform;
    TransVar := Transf.Inputs.Item(0);
    Slice := TransVar.Slices.Item(0);
    TermInfo := Transf.CreateTermInfo;
    TermInfo.Slice := Slice;
    TermInfo.Type := MsFormulaTermType.Serie;
    Inp_1 := TermInfo.TermInnerText;
    TransVar := Transf.Inputs.Item(1);
    Slice := TransVar.Slices.Item(0);
    TermInfo := Transf.CreateTermInfo;
    TermInfo.Slice := Slice;
    TermInfo.Type := MsFormulaTermType.Pointwise;
    Expr := Determ.Expression;
    Expr.References := "Ms";
    Expr.AsString := TermInfo.TermInnerText + "+Median(" + Inp_1 + ")";
    If Expr.Valid
        Then ModelObj.Save;
        Else Debug.WriteLine("The model is not saved: error in formula");
    End If;
End Sub UserProc;

After executing the example the model calculates values of the second input variable increased by the median value of the first input variable.

Example of Use in Expressions

Expression 1:

Median({Brazil|BCA},{Peru|BCA}, False, SetPeriod(2000,2010))

Result: the median of corresponding observations of the Brazil|BCA and Peru|BCA series taking into account empty values from 2000 to 2010.

Use: it can be used in formulas of cross functional expression editor in any platform tool where it is available.

Expression 2:

Median(X1, SetPeriod(2000,2010))

Result: the median of the X1 factor for the period from 2000 to 2010.

Use: it can be used in model formulas of modeling container based on variables.

Expression 3:

Median(1, 2, 3, 4)

Result: 2.5.

Application: it can be used in any expressions.

See also:

IModelling | Median | Time Series Database: Calculator | Modeling Container: Editing Regressor or Formula