Oms API GET Run Microdata csv compare Ids - openmpp/openmpp.github.io GitHub Wiki

Compare microdata values and return results as csv file.

Compare [base] and [variant] model runs microdata value attributes (float of integer type), group it by dimension attributes (enum-based or bool type) and get it as response stream UTF-8 Entity.csv file attachment, optionally starts with byte order mark (BOM).

Result can include multiple aggregated comparisons, grouped by multiple dimension attributes. Aggregated comparision(s) is a comma-separated list of Model Output Expressions of [base] and [variant] value attributes. For example, two comparisions: OM_AVG(Income[variant] - Income[base]) , OM_MAX( 100 * (Salary[variant] + Pension[variant]) / Income[base]) and group by two dimension attributes: AgeGroup , Sex.

It is also possible to use parameter(s) in calculation, parameter must be a scalar of float or integer type. For example: OM_COUNT_IF((Income[variant - Income[base]) > param.High[base]), where param.High[base] is a value of scalar parameter High in [base] model run.

Enum-based microdata attributes returned as enum id, not enum codes.

Following aggregation functions avaliable:

  • OM_AVG mean of accumulators sub-values
  • OM_SUM sum of accumulators sub-values
  • OM_COUNT count of accumulators sub-values (excluding NULL's)
  • OM_COUNT_IF count values matching condition
  • OM_MAX maximum of accumulators sub-values
  • OM_MIN minimum of accumulators sub-values
  • OM_VAR variance of accumulators sub-values
  • OM_SD standard deviation of accumulators sub-values
  • OM_SE standard error of accumulators sub-values
  • OM_CV coefficient of variation of accumulators sub-values

For more details please see: Model Output Expressions

Methods:

GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/compare/:compare/variant/:variant/csv-id
GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/compare/:compare/variant/:variant/csv-id-bom

Arguments:

:model - (required) model digest or model name

Model can be identified by digest or by model name. It is recommended to use digest because it is uniquely identifies model. It is possible to use model name, which is more human readable than digest, but if there are multiple models with same name in database than result is undefined.

:run     - (required) base model run digest, run stamp or run name
:variant - (required) variant model run(s): comma-separated list of digests, run stamps or run names

Model run can be identified by run digest, run stamp or run name. It is recommended to use digest because it is uniquely identifies model run. Run stamp, if not explicitly specified as model run option, automatically generated as timestamp string, ex.: 2016_08_17_21_07_55_123. It is also possible to use name, which is more human readable than digest, but if there are multiple runs with same name in database than result is undefined.

:name - (required) microdata entity name

:group-by - (required) comma-separated list of dimension attribute(s) to group by aggreagated values, dimension attribute must be enum-based or boolean type.

:compare - (required) comma-separated list of comparions of microdata value attribute(s), value attribute must be float of integer type.

Call examples:

http://localhost:4040/api/model/modelOne/run/Microdata%20in%20database/microdata/Person/group-by/AgeGroup,Sex/compare/OM_AVG(Income%5Bvariant%5D-Income%5Bbase%5D)/variant/Microdata%20other%20in%20database/csv-id
http://localhost:4040/api/model/modelOne/run/Microdata%20in%20database/microdata/Person/group-by/AgeGroup,Sex/compare/OM_AVG(Income%5Bvariant%5D-Income%5Bbase%5D)/variant/Microdata%20other%20in%20database/csv-id-bom

http://localhost:4040/api/model/modelOne/run/Microdata%20in%20database/microdata/Person/group-by/AgeGroup,Sex/compare/OM_AVG(Income%5Bvariant%5D-Income%5Bbase%5D),OM_AVG(Salary)/variant/Microdata%20other%20in%20database/csv-id
http://localhost:4040/api/model/modelOne/run/Microdata%20in%20database/microdata/Person/group-by/AgeGroup,Sex/compare/OM_AVG(Income%5Bvariant%5D-Income%5Bbase%5D),OM_AVG(Salary)/variant/Microdata%20other%20in%20database/csv-id-bom
http://localhost:4040/api/model/modelOne/run/Microdata%20in%20database/microdata/Person/group-by/AgeGroup,Sex/compare/OM_AVG((Income%5Bvariant%5D-Income%5Bbase%5D)%2Aparam.StartingSeed%5Bbase%5D)/variant/Microdata%20other%20in%20database/csv-id

Note:

  • OM_AVG(Income%5Bvariant%5D-Income%5Bbase%5D) is URL encoded: OM_AVG(Income[variant]-Income[base])
  • OM_AVG((Income%5Bvariant%5D-Income%5Bbase%5D)%2Aparam.StartingSeed%5Bbase%5D) is URL encoded: OM_AVG((Income[variant]-Income[base])*param.StartingSeed)[base]

Return example:

curl http://localhost:4040/api/model/modelOne/run/Microdata%20in%20database/microdata/Person/group-by/AgeGroup,Sex/compare/OM_AVG(Income%5Bvariant%5D-Income%5Bbase%5D)/variant/Microdata%20other%20in%20database/csv-id

run_id,calc_id,AgeGroup,Sex,calc_value
221,12000,10,0,-6701256.20161906
221,12000,10,1,-6702689.14390467
221,12000,20,0,-67108864
221,12000,20,1,-67112960
221,12000,30,0,-67149824
221,12000,30,1,-67153920
221,12000,40,0,-37327458.4707197
221,12000,40,1,-35538991.0909255

curl http://localhost:4040/api/model/modelOne/run/Microdata%20in%20database/microdata/Person/group-by/AgeGroup,Sex/compare/OM_AVG(Income%5Bvariant%5D-Income%5Bbase%5D),OM_AVG(Salary)/variant/Microdata%20other%20in%20database/csv-id

run_id,calc_id,AgeGroup,Sex,calc_value
219,12001,10,0,10050657.2657706
219,12001,10,1,10052806.4168194
219,12001,20,0,100651008
219,12001,20,1,100657151.25
219,12001,30,0,100712440.5
219,12001,30,1,100718583.75
219,12001,40,0,44905401.6613024
219,12001,40,1,41552168.3348642
221,12000,10,0,-6701256.20161906
221,12000,10,1,-6702689.14390467
221,12000,20,0,-67108864
221,12000,20,1,-67112960
221,12000,30,0,-67149824
221,12000,30,1,-67153920
221,12000,40,0,-37327458.4707197
221,12000,40,1,-35538991.0909255
221,12001,10,0,5024715.11455629
221,12001,10,1,5025789.55889093
221,12001,20,0,50319360
221,12001,20,1,50322431.25
221,12001,30,0,50350072.5
221,12001,30,1,50353143.75
221,12001,40,0,22449959.7419271
221,12001,40,1,20773547.8187544
⚠️ **GitHub.com Fallback** ⚠️