Note: You are currently viewing documentation for Moodle 3.6. Up-to-date documentation for the latest stable version of Moodle is likely available here: Grade calculations.

Grade calculations: Difference between revisions

From MoodleDocs
(Undo revision 131128 by Juacas (talk) Functionality under peer review yet.)
m (Improved wording and correction of some typos)
Line 1: Line 1:
{{Managing grades}}
{{Managing grades}}
A grade calculation is a formula used to determine grades, based (optionally) on other grade items. Note that this is not the same as [[Calculated_question_type|Calculated question types]].
A grade calculation is a formula used to determine grades, based on other grade items. Note that this is not the same as [[Calculated_question_type|Calculated question types]].


Calculations for the gradebook follow the pattern of formulas/functions in popular spreadsheet programs. They start with an equal (=) sign, and use common mathematical operators and functions to produce a single numerical output. This output is then used as the computed value for the grade item you are editing.
Grade calculations follow the pattern of formulas/functions in popular spreadsheet programs. They start with an equal (=) sign, and use common mathematical operators and functions to produce a single numerical output. This output is then used as the computed value for the grade item you are editing.


==Setting a grade calculation==
==Setting a grade calculation==
Line 13: Line 13:
# Click the 'Edit settings' and then 'Edit calculation'. Note: if you don't see this, then it must be enabled in ''Site administration>Grades>Report settings>Grader report''
# Click the 'Edit settings' and then 'Edit calculation'. Note: if you don't see this, then it must be enabled in ''Site administration>Grades>Report settings>Grader report''
# Start with an equal sign (=)
# Start with an equal sign (=)
# Type an expression using numbers, arithmetic opertors, mathematical functions and ID numbers; for example <nowiki>=average()</nowiki>
# Type an expression using numbers, arithmetic operators, mathematical functions and ID numbers; for example <nowiki>=average()</nowiki>
# Plug in your ID numbers (see below) enclosed in double square brackets, for example <nowiki>=[[item1]]+[[item2]]</nowiki>
# Plug in your ID numbers (see below) enclosed in double square brackets, for example <nowiki>=[[item1]]+[[item2]]</nowiki>
# Separate each ID number with a comma, for example <nowiki>=average([[item1]], [[item2]])+[[item3]]</nowiki>
# Separate each function argument with a comma, as in <nowiki>=average([[item1]], [[item2]])+[[item3]])</nowiki>
# Click the "Save Changes" button
# Click the "Save Changes" button


==Assigning ID numbers==
==Assigning ID numbers==


You can include the values of other grade items by using their ID number as references in your formulas. The ID number is surrounded by double square brackets, for example if you have a grade item with Quiz.3 as ID number, you will refer to this item as <nowiki>[[Quiz.3]]</nowiki> in your calculation.
You can include the values of other grade items by using their ID number as references in your formulas. The ID number must be surrounded by double square brackets, for example if you have a grade item with Quiz.3 as ID number, you can refer this item using <nowiki>[[Quiz.3]]</nowiki> in your calculation.


Below the calculation field is a list of your course with its grade categories and grade items. Next to each item or category's total is displayed the ID number you can use in your calculation (already surrounded with double square brackets). However, since the ID number is optional, some items may not yet have one. These items without an ID number have instead a form field which lets you enter an ID number directly.
Below the calculation field there is a list of your course grade categories and grade items. Next to each item or category's total there is the ID number you can use in your calculation (already surrounded with the required double square brackets).


As soon as you have assigned the ID numbers you need, you can click the "Add ID numbers" button, and the page will reload and show you the same list with the ID numbers you have just assigned. Now you can use them in your formulas.
However, since ID numbers are optional, some items may not yet have one. Each item without ID number have a form field that you can use to enter its ID number directly. As soon as you have assigned the ID numbers you need, you must click the "Add ID numbers" button; the page will reload and show you the same list including the ID numbers you have just assigned. Now you can use them in your grade calculation.
 
'''Note''': Moodle does not allow calculations involving no ID numbers.


==Calculation functions==
==Calculation functions==


Every calculation must start with an equal sign (=). Following is an expression using operators and functions supported by the system.
Every grade calculation must start with an equal sign (=) followed by an expression using operators and functions supported by the system.
All common arithmetic operators are supported:
All common arithmetic operators are supported


* addition, using the plus (+) sign
* addition, using the plus (+) sign
Line 37: Line 39:
* exponentiation, using the caret (^) character
* exponentiation, using the caret (^) character


with their usual precedence rules: exponentiations are evaluated first, then multiplications and divisions are performed, finally additions and subtraction are carried out; so, the expression =1+2-3*4/5^6 gives almost 3 (2,999232). Precedences can be forced using parentheses, as in the expression =((((1+2)-3)*4)/5)^6 which yields 0.
with their usual evaluation precedence rules: exponentiations are evaluated first, then multiplications and divisions are performed, finally additions and subtraction are carried out; so, the expression =1+2-3*4/5^6 gives almost 3 (2,999232). Different precedences can be forced using round parentheses, as in the expression =((((1+2)-3)*4)/5)^6 which yields 0.
 
'''Note''': Moodle does not allow calculations involving no ID numbers.


Functions can also appear in expressions, using the comma (,) character to separate their arguments listed within function (round) brackets. (The separator character could be a semicolon (;) in other [[Language|languages]], see below).
Functions can also appear in expressions, using the comma (,) character to separate their arguments listed within round brackets. (Note that the separator character could be a semicolon (;) in other [[Language|languages]], see below).


* average<nowiki>([[item1]], [[item2]]...)</nowiki>: Returns the average of the values in a list of arguments
* average<nowiki>([[item1]], [[item2]]...)</nowiki>: Returns the average of the values in a list of arguments
* max<nowiki>([[item1]], [[item2]]...)</nowiki>: Returns the maximum value in a list of arguments
* max<nowiki>([[item1]], [[item2]]...)</nowiki>: Returns the maximum value in a list of arguments
* min<nowiki>([[item1]], [[item2]]...):</nowiki> Returns the minimum value in a list of arguments
* min<nowiki>([[item1]], [[item2]]...)</nowiki>: Returns the minimum value in a list of arguments
* mod(dividend, divisor): Calculates the remainder of a division
* mod(dividend, divisor): Calculates the remainder of a division
* pi(): Returns the value of the number Pi
* pi(): Returns the value of the number Pi (3.14159265...)
* power(base, power): Raises a number to the power of another
* power(base, exponent): Raises a number to the exponent power (this is the same as base^exponent)
* round(number, count): Rounds number to count decimal digits
* round(number, count): Rounds number to count decimal digits
* floor(number): Maps a real number to the largest previous integer
* floor(number): Maps a real number to the largest previous integer
* ceil(number): Maps a real number to the smallest following integer
* ceil(number): Maps a real number to the smallest following integer
* sum(<nowiki>[[item1]], [[item2]]...)</nowiki>: Returns the sum of all arguments
* sum<nowiki>([[item1]], [[item2]]...)</nowiki>: Returns the sum of all arguments (this is the same as <nowiki>[[item1]]+[[item2]]+...</nowiki>


Many other mathematical functions are also supported:
Many other mathematical functions are also supported:
Line 82: Line 82:
==Example calculations==
==Example calculations==


* <nowiki>=max([[Quiz.1]], [[Quiz.4]], [[Assignment.1]])</nowiki> - Returns the maximum value of Quiz.1, Quiz.4 and Assignment.1
* <nowiki>=max([[Quiz.1]], [[Quiz.4]], [[Assignment.1]])</nowiki> - Returns the maximum value of the grades referred by Quiz.1, Quiz.4 and Assignment.1
* <nowiki>=average(max([[Quiz.1]], [[Quiz.4]], [[Assignment.1]]), min([[Quiz.1]], [[Quiz.4]], [[Assignment.1]]))</nowiki> - Returns the average of the maximum and the minimum values among Quiz.1, Quiz.4 and Assignment.1 (functions can be nested)
* <nowiki>=average(max([[Quiz.1]], [[Quiz.4]], [[Assignment.1]]), min([[Quiz.1]], [[Quiz.4]], [[Assignment.1]]))</nowiki> - Returns the average of the maximum and the minimum values among Quiz.1, Quiz.4 and Assignment.1 (functions can be nested)
* <nowiki>=sum([[1]]*0.3, [[2]]*0.6, [[3]]*2)</nowiki> - Returns a weighted grade calculations where item 1 is weighted 30%, item 2 is weighted at 60% and item 3 is weighted at 200%
* <nowiki>=sum([[item1]]*0.3, [[item2]]*0.6, [[item3]]*2)</nowiki> - Returns a weighted grade sum where item1 is weighted 30%, item2 is weighted at 60% and item3 is weighted at 200%


==Calculations when user language is not English==
==Calculations when user language is not English==


Calculation formulas use decimal and list separators as defined in the [https://docs.moodle.org/dev/Translation_langconfig langconfig.php] file of each [[Language packs|language pack]].
Calculation can formulas use decimal and list separators as defined in the [https://docs.moodle.org/dev/Translation_langconfig langconfig.php] file of each [[Language packs|language pack]].


The [[Decimal separator|decimal separator]] (a symbol used to mark the boundary between the integral and the fractional parts of a decimal number) is a point (.) in English. In other languages it may be a comma (,).
The [[Decimal separator|decimal separator]] (the symbol used to mark the boundary between the integral and the fractional parts of a decimal number) is a point (.) in English. In other languages it may be a comma (,).


The list separator (a symbol used to separate the items within a list, such as the arguments of a function) is a comma (,) in English. In other languages it may be a semicolon (;).
Analogously, the list separator (the symbol used to separate the items within a list, such as the arguments of a function) is a comma (,) in English. In other languages it may be a semicolon (;).


==See also==
==See also==

Revision as of 11:59, 21 January 2019

A grade calculation is a formula used to determine grades, based on other grade items. Note that this is not the same as Calculated question types.

Grade calculations follow the pattern of formulas/functions in popular spreadsheet programs. They start with an equal (=) sign, and use common mathematical operators and functions to produce a single numerical output. This output is then used as the computed value for the grade item you are editing.

Setting a grade calculation

Edit calculation setting
Example calculation

To set a grade calculation:

  1. Login as teacher or other user with permission to edit grades
  2. Click on Grades in the course administration block
  3. Click the 'Categories and items'
  4. Click the 'Edit settings' and then 'Edit calculation'. Note: if you don't see this, then it must be enabled in Site administration>Grades>Report settings>Grader report
  5. Start with an equal sign (=)
  6. Type an expression using numbers, arithmetic operators, mathematical functions and ID numbers; for example =average()
  7. Plug in your ID numbers (see below) enclosed in double square brackets, for example =[[item1]]+[[item2]]
  8. Separate each function argument with a comma, as in =average([[item1]], [[item2]])+[[item3]])
  9. Click the "Save Changes" button

Assigning ID numbers

You can include the values of other grade items by using their ID number as references in your formulas. The ID number must be surrounded by double square brackets, for example if you have a grade item with Quiz.3 as ID number, you can refer this item using [[Quiz.3]] in your calculation.

Below the calculation field there is a list of your course grade categories and grade items. Next to each item or category's total there is the ID number you can use in your calculation (already surrounded with the required double square brackets).

However, since ID numbers are optional, some items may not yet have one. Each item without ID number have a form field that you can use to enter its ID number directly. As soon as you have assigned the ID numbers you need, you must click the "Add ID numbers" button; the page will reload and show you the same list including the ID numbers you have just assigned. Now you can use them in your grade calculation.

Note: Moodle does not allow calculations involving no ID numbers.

Calculation functions

Every grade calculation must start with an equal sign (=) followed by an expression using operators and functions supported by the system. All common arithmetic operators are supported

  • addition, using the plus (+) sign
  • subtraction, using the minus (-) sign
  • multiplication, using the asterisk (*) character
  • division, using the slash (/) character
  • exponentiation, using the caret (^) character

with their usual evaluation precedence rules: exponentiations are evaluated first, then multiplications and divisions are performed, finally additions and subtraction are carried out; so, the expression =1+2-3*4/5^6 gives almost 3 (2,999232). Different precedences can be forced using round parentheses, as in the expression =((((1+2)-3)*4)/5)^6 which yields 0.

Functions can also appear in expressions, using the comma (,) character to separate their arguments listed within round brackets. (Note that the separator character could be a semicolon (;) in other languages, see below).

  • average([[item1]], [[item2]]...): Returns the average of the values in a list of arguments
  • max([[item1]], [[item2]]...): Returns the maximum value in a list of arguments
  • min([[item1]], [[item2]]...): Returns the minimum value in a list of arguments
  • mod(dividend, divisor): Calculates the remainder of a division
  • pi(): Returns the value of the number Pi (3.14159265...)
  • power(base, exponent): Raises a number to the exponent power (this is the same as base^exponent)
  • round(number, count): Rounds number to count decimal digits
  • floor(number): Maps a real number to the largest previous integer
  • ceil(number): Maps a real number to the smallest following integer
  • sum([[item1]], [[item2]]...): Returns the sum of all arguments (this is the same as [[item1]]+[[item2]]+...

Many other mathematical functions are also supported:

  • sin()
  • sinh()
  • arcsin()
  • asin()
  • arcsinh()
  • asinh()
  • cos()
  • cosh()
  • arccos()
  • acos()
  • arccosh()
  • acosh()
  • tan()
  • tanh()
  • arctan()
  • atan()
  • arctanh()
  • atanh()
  • sqrt()
  • abs()
  • ln()
  • log()
  • exp()

Example calculations

  • =max([[Quiz.1]], [[Quiz.4]], [[Assignment.1]]) - Returns the maximum value of the grades referred by Quiz.1, Quiz.4 and Assignment.1
  • =average(max([[Quiz.1]], [[Quiz.4]], [[Assignment.1]]), min([[Quiz.1]], [[Quiz.4]], [[Assignment.1]])) - Returns the average of the maximum and the minimum values among Quiz.1, Quiz.4 and Assignment.1 (functions can be nested)
  • =sum([[item1]]*0.3, [[item2]]*0.6, [[item3]]*2) - Returns a weighted grade sum where item1 is weighted 30%, item2 is weighted at 60% and item3 is weighted at 200%

Calculations when user language is not English

Calculation can formulas use decimal and list separators as defined in the langconfig.php file of each language pack.

The decimal separator (the symbol used to mark the boundary between the integral and the fractional parts of a decimal number) is a point (.) in English. In other languages it may be a comma (,).

Analogously, the list separator (the symbol used to separate the items within a list, such as the arguments of a function) is a comma (,) in English. In other languages it may be a semicolon (;).

See also