Skip to content

Commit 3d91ff5

Browse files
anadis504anadis504
authored
Sum factor (#54)
* define a sum-factor and implement its editor * implementation of the sum factorial report * Sum-factor report implemented in submission view, non-factorial survey has weighted options * fix freaking weird bug in the color palette element * fancy up the forms and the sum factor report * update snap-shots * make condition of factorial-options * improve factor report layouts and designs * update snapshots * final clean-up and documenting privateSpec * add tests and snapshots * fix window scaling for sum-factor report * update user manual * update tests and snapshots * fix test * fix test 2
1 parent 792807a commit 3d91ff5

38 files changed

Lines changed: 3340 additions & 133 deletions

File tree

‎docs/imgs/sum-factor-report.png‎

10.1 KB
Loading

‎docs/usermanual.md‎

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ First select the appropriate exercise type from the exercise selector:
88

99
### There are 2 types of surveys:
1010

11-
| factorial | non-factorial |
12-
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
13-
| This survey type is meant for building the factorial survey type for calculating and outputting a factorial report to the user based on the user answers. It can also be used for a set of questions having the same answer options (single-choice). For example: | This survey type lets you create survey questions of type: |
14-
| ![example of questions with same answer options](./imgs/questions_with_same_options_example.png) | <ul><li> free text</li><li> number</li><li>date</li><li>multiple-choice</li><li>single choice:<ul><li>radio-group</li><li>drop-down selection: the advanced drop-down selection allows the user to start typing in the search bar and provides answer alternatives matching the user input, in case of a very long option list.</li></ul></li><li>info element</li></ul> |
11+
| factorial | non-factorial |
12+
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13+
| This survey type is meant for building the factorial survey type for calculating and outputting a factorial report to the user based on the user answers. It can also be used for a set of questions having the same answer options (single-choice). For example: | This survey type lets you create survey questions of type: |
14+
| ![example of questions with same answer options](./imgs/questions_with_same_options_example.png) | <ul><li> free text</li><li> number</li><li>date</li><li>multiple-choice</li><li>single choice:<ul><li>radio-group</li><li>weighted-radio-group: looks just like radio-group to student, but the options are mapped with weights enabling summing up a ["survey score"](#sum-factor-report)</li><li>drop-down selection: the advanced drop-down selection allows the user to start typing in the search bar and provides answer alternatives matching the user input, in case of a very long option list.</li></ul></li><li>info element</li></ul> |
1515

1616
## Building a survey
1717

@@ -51,7 +51,7 @@ The list can be modified to insert elements or remove elements from the list.
5151

5252
<img src="./imgs/submission_view_parameters.png" width=600 position=left>
5353

54-
> This box defines the given parameters for the given task only, that is, if the exercise consists of more than one task each of them may have its own title and feedback text. Non-factorial survey cannot failby default, so there is no failure message to be defined. Factorial survey displays the failure message in case of "unable to calculate report".
54+
> This box defines the given parameters for the given task only, that is, if the exercise consists of more than one task each of them may have its own title and feedback text. Non-factorial survey cannot fail by default, so there is no failure message to be defined. Factorial survey displays the failure message in case of "unable to calculate report".
5555
5656
Some or all of the fields may be left empty.
5757

@@ -88,7 +88,9 @@ By clicking the "duplicate item" button, a new survey item will be inserted belo
8888

8989
### Making questions render conditionally
9090

91-
By ticking the box "Conditional" you can choose what condition the question will be rendered on. The condition is another question within the same `task` containing options. The conditional question will be rendered once the survey user selects that particular option from that question. Questions can be made "double conditional" (or triple and so on) by depending on other conditional questions.
91+
By ticking the box "Conditional" you can choose what condition the question will be rendered on. The condition is another question within the same `task` containing `options`. The question may depend on several options from several questions, meaning that the question is rendered if **ANY** of the conditions are satisfied. The condition .is satisfied if the student selects an option from the list of conditions.
92+
93+
Questions may be made "double conditional" (or triple and so on) by depending on other conditional questions. In other words, chaining conditions.
9294

9395
<p>&nbsp;</p>
9496

@@ -100,12 +102,36 @@ By ticking the box "Make global" the answer of this question is made available f
100102
101103
where on the left hand side of `=` the `question_label` is the unique question label of the global question and on the right-hand-side `default value` is any value (text) that is rendered in case the user has not answered that question yet. The `default value` can be left empty.
102104

105+
<p>&nbsp;</p>
106+
107+
### Mandatory questions
108+
109+
By ticking out the `Mandatory` checkbox the student may not submit the survey form unless the question is answered. It is possible to make conditional questions mandatory, the conditional question then affects form validation only if rendered (that is, its condition is met and the question is displayed).
110+
111+
<p>&nbsp;</p>
112+
103113
### Duplicate item
104114

105115
The button `duplicate item` will create a new survey item below the given item with the exact same list of options. The question label and question text need still be defined. The list of options as well as the answer type can still be modified in both of the survey items independently.
106116

107117
<p>&nbsp;</p>
108118

119+
### Sum factor report
120+
121+
It is possible to build a one-factor report based on the sum of `weighted-radio-group` answers. Just tick the box `Calculate sum-factor report to student` and define the visualization report by adding "sub-categories" to the report. The report will be rendered below for inspection during the editing.
122+
123+
The end result will look exactly like the displayed vasualization (except for the user legend moving along the category-bars).
124+
125+
Student view:
126+
127+
<img src="./imgs/sum-factor-report.png" width=600>
128+
129+
The user score key legend is defined in the same way as in factorial survey [report creation](#define-user-variables) section: Label for user score.
130+
131+
> The `global variable` to impute to the user legend may also come from the same survey form as the one building this report. The key legend will be imputed upon form submission.
132+
133+
<p>&nbsp;</p>
134+
109135
## Factorial survey
110136

111137
The factorial survey type is ment for a set of questions having same set of answer options. Based on the answers of a survey it is possible to calculate and provide a factorial report to the student upon submission based on static analysis numbers defined by the survey maker.
@@ -178,7 +204,11 @@ Each column will be added as a factor and for each factor a factor-editor will a
178204

179205
<img src="./imgs/other_documents_factorial.png" width=600>
180206

181-
| | Define the user variables |
207+
<br/>
208+
209+
## Define user variables
210+
211+
| | |
182212
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
183213
| normalization values | _(Optional)_ normalization values are uploaded in the same way as the factor-weight values. On succesful parsing the values will be displayed in the same matrix as the factor-weights. If not defined the user answers will not be normilized and used in the calculations as is. |
184214
| Label for user score | Here it is possible to insert a [global variable](#make-global), i. e. a user answer to a question somewhere else in this course ( preferrably earlier and in particular in a [non-factorial survey](#non-factorial-survey)) that is marked `global`. The `question_label` of the given question is given in the `Global variable key for user icon` text-box. In case the survey user does not have such a variable (has not answered and submitted the survey with the global question) a default value to be used is spesified in the `Default label for user score icon` text-box. The icon to represent the user score can be defined in the icon selection dropdown. |

0 commit comments

Comments
 (0)