10.11. Manage predictors

10.11.1. About predictors

Predictors are data elements that are automatically generated from samples of current and past data. You use predictors to analyse previous data in order to predict future values, for example for disease surveillance.

A predictor specifies an expression and a set of sample constraints, identical to the implementation of validation rules. This includes a period type, organisation unit levels, and parameters specifying past or periodic sample windows. The expression should evaluate to true or false.

In the Maintenance app, you manage the following predictor objects:

Table 10.18. Predictor objects in the Maintenance app

Object type

Available functions

Predictor

Create, edit, clone, delete, show details and translate


10.11.2. Create a predictor

  1. Open the Maintenance app and click Other > Predictor.

  2. Click the add button.

  3. In the Name field, type the predictor name.

  4. (Optional) In the Code field, assign a code.

  5. Select an Output data element.

  6. (Optional) Type a Description.

  7. Select a Period type.

  8. (Optional) Assign organisation unit levels.

  9. Create a Generator.

    The generator is the expression that is used to calculate the predicted value.

  10. (Optional) Click Sample skip test and create an expression which is used to exclude data from the generation process. The expression should evaluate to true or false.

    Example 10.13. 

    Use the sample skip test when you want to calculate the average number of malaria cases and you want to exclude the "spikes" you get from outbreaks.


  11. Enter a Sequential sample count value.

    This value decides for how many sequential periods the calculation should go back in time to collect data for the calculations. The sequential sample count depends on the value type.

    Example 10.14. 

    If the period type is "Monthly" and the sequential sample count is "3", the predictor calculations will include data three months back in time.


  12. Enter an Annual sample count value.

    This value decides for how many years the calculation should go back in time to collect data for the calculations. The annual sample count depends on the value type and sequential sample count.

    Example 10.15. 

    If the period type is "Monthly", the sequential sample count is "3" and the annual sample count is "4", the predictor calculations will include data three months back in time for this year and for two (3-1) years back in time:

    June, July, August 2016; June, July, August, 2015; and June, July, August 2014.


  13. (Optional) Enter a Sequential skip count value.

    This value decides how many periods the calculation should go back in time before the sequential sample count starts. The sequential skip count depends on the value type and sequential sample count.

    Example 10.16. 

    If the period type is "Monthly", the sequential sample count is "3" and the sequential sample count is " 2", the predictor calculations will go back two months in time, then include the following three months in the calculations:

    April, May and June (July and August are skipped because the sequential skip count is "2")


  14. Click Save.

10.11.3. Edit metadata objects

  1. Open the Maintenance app and find the type of metadata object you want to edit.

  2. In the object list, click the options menu and select Edit.

  3. Modify the options you want.

  4. Click Save.

10.11.4. Clone metadata objects

  1. Open the Maintenance app and find the type of metadata object you want to clone.

  2. In the object list, click the options menu and select Clone.

  3. Modify the options you want.

  4. Click Save.

10.11.5. Delete metadata objects

  1. Open the Maintenance app and find the type of metadata object you want to delete.

  2. In the object list, click the options menu and select Delete.

  3. Click Confirm.

10.11.6. Display details of metadata objects

  1. Open the Maintenance app and find the type of metadata object you want to view.

  2. In the object list, click the options menu and select Show details.

10.11.7. Translate metadata objects

  1. Open the Maintenance app and find the type of metadata object you want to translate.

  2. In the object list, click the options menu and select Translate.

  3. Select a locale.

  4. Type a Name, Short name and Description.

  5. Click Save.