Wiki source code of Setting up Algorithms

Last modified by karimpirani on 2014/07/01 15:53

version	line-number	content
15.2	1	__SETTING UP ALGORITHMS__
	2
	3	Algorithms provide a system of heuristics for data analysis and classification.
	4
	5	~1. In order to set up an algorithm, you must select the "Reports and Analytics" tab on the top menu bar of the system.
	6
16.2	7	1.1 When the pull-down menu appears, scroll down to the second option marked "Algorithms"
15.2	8
16.2	9	1.2 In the subsequent menu which will open on the right hand side, select the "Design and Process Algorithms" option. This will take you to the main algorithms page
	10
12.1	11	[[image:algorithms 1.PNG\|\|width="100%"]]
5.2	12
16.2	13	2. The main algorithm creation and editing page should come up. This page allows you to take many actions, including designing and running and publishing algorithms
5.2	14
16.2	15	2.1 To begin the process of creating an algorithm which will analyze data of your choosing, click the New button represented by the green plus icon on the bottom menu bar of options.
5.2	16
21.1	17	[[image:algorithms 2.PNG\|\|width="100%"]]
5.2	18
16.2	19
18.2	20	3. A blank "Create a New Algorithm" page will appear. You can populate this page with information about the new algorithm you intend to run.
16.2	21
18.2	22	3.1 In the name box, type in a name that will help you categorize the algorithm or find it later.
5.2	23
18.2	24	3.2 In the description box, type in a description of your algorithm.
5.2	25
18.2	26	[[image:algorithms 3.PNG]]
5.2	27
	28
18.2	29	4 Note, you are given a choice of what type of algorithm you want to run, and Assessment Algorithm or a Classification Algorithm.
	30
18.3	31	4.1 An Assessment Algorithm allows you to look at the results of various assessments to make predictions about clients.
18.2	32
18.3	33	4.2 A Classification Algorithm is intended more for notification purposes and uses data to alert users as to certain client information.
	34
13.1	35	[[image:algorithms 4.PNG\|\|style="width: 50%; margin-right: auto; margin-left: auto; display: block;"]]
8.2	36
	37
18.3	38	5. If you choose to employ an Assessment Algorithm, a larger box will appear for more data entry.
	39
	40	5.1 Instrument: you will be asked to select what instrument you want your algorithm to be run on
	41
	42	5.2 Processor Strategy: you can choose between a "Standard Assessment Algorithm Processor" or a "Logical Assessment Algorithm Processor"
	43
	44
	45	* Standard:
	46	* Logical:
	47
22.1	48	[[image:algorithms 5.PNG\|\|style="width: 50%; margin-right: auto; margin-left: auto; display: block;"]]
8.2	49
	50
18.3	51	6. In the Classification Algorithm option, you will be taken to this main screen for data entry and choice options.
8.2	52
18.3	53	6.1 Note the name and description appear toward the top of the screen
	54
18.4	55	6.2 In the Configurations tab, you have several options, called factors (which are further elaborated below in step 7)
18.3	56
18.4	57	6.3 The Score Aggregation Formula asks whether you want to give weight to the different factors or whether you merely want to note their presence
	58
	59
	60	* To give weight to the factors, you must click on the down arrow and select the option for "Strength of Classification"
	61	* To only note the presence of the factors, you can keep the default option of "Exists in Classification"
	62
12.1	63	[[image:algorithms 6.PNG\|\|width="100%"]]
8.2	64
18.5	65	7. Next, we will deal with choosing and assigning factors for consideration in your algorithm
8.2	66
18.5	67	7.1 Each factor represents a different domain or its item of interest whose scores may prove relevant to your algorithm
8.2	68
18.5	69	7.2 To add a factor, simply click on the factor/domain (which should open a list of its items) and select which items are of import to you. Then, click on the add factor button represented by the green plus icon
18.4	70
18.5	71	7.3 The new factor(s) should now be displayed on the right pane.
	72
	73	7.4 To remove a factor, simply select it on the right side and click on the Remove Factor button represented by the red minus icon
	74
	75	7.5 NOTE: the factors will all show up on the right side with a score of 1. To change the score of interest to better represent what you are looking for, you can double click on the numeral and enter your own score which would then be classified as the risk level you designate it as.
	76
22.3	77	* TIP: When moving from one column to the next in the same row, you may simply press ‘tab’ on your keyboard.
22.2	78
12.1	79	[[image:algorithms 7.PNG\|\|width="100%"]]
8.2	80
	81
18.5	82	8. We now turn to the "Score Classification" tab
11.2	83
18.8	84	8.1 This tab allows you to give ranges for classification. This means that you can set the upper and lower bounds for various levels of risk, severity, etc. that you can define yourself
11.2	85
18.8	86	8.2 To change the bounds or the name of the classification, simply double click on the generic entries already in the box and you should be able to re-name or re-number the fields
	87
22.2	88	8.3 NOTE: the lower bound is inclusive, while the upper bound is not
	89
12.1	90	[[image:algorithms 8.PNG\|\|width="100%"]]
11.2	91
	92
18.8	93	~** APPLIES ONLY TO ASSESSMENT ALGORITHM ~~
11.2	94
19.1	95	9. You have several options in the Configurations tab
18.8	96
19.1	97	9.1 Like the Classification Algorithm, you can select certain factors (in this case, the various domains and items relating to the assessment you previously chose as the instrument) to add or remove as part of your algorithm's consideration
	98
	99	9.2 Again, like the Classification Algorithm, you can give different weights to the different items, which will impact your overall evaluation
	100
	101	9.3 A new option in the Assessment Algorithm is the ability to choose your own score aggregation formula, meaning you can decide how you want the data to be considered
	102
	103
	104	* Sum: simply adds all the factors and their weights
	105	* Mean: takes the arithmetic average of the scores
	106	* Complexity Score:
	107	* Mean x 10:
	108
12.1	109	[[image:algorithms 9.PNG\|\|width="100%"]]
22.3	110
	111
	112
	113	10. Now that all the criteria have been entered, you can choose to include the results of the algorithm in you printed assessment report. In order to do this, you only have to check off the box labeled “Include algorithm results when assessments are printed.”
	114
	115
22.4	116	~11. Congratulations your algorithm is ready to publish! In order to do this, you must hit the "Save and Publish" button located at the bottom of your screen. Note: the publishing time of the algorithm may vary depending on the complexity of assessments and amount of data. Please be patient as the process may take about a minute.