Potential cognitive depth indicator.
More...
|
| add_sample_data ($data) |
| add_sample_data
|
|
| calculate ($sampleids, $samplesorigin, $starttime=false, $endtime=false, $existingcalculations=array()) |
| Calculates the indicator.
|
|
| calculate_sample ($sampleid, $sampleorigin, $notusedstarttime=false, $notusedendtime=false) |
| calculate_sample
|
|
| clear_sample_data () |
| clear_sample_data
|
|
| fill_per_analysable_caches (\core_analytics\analysable $analysable) |
| Hook to allow indicators to pre-fill data that is shared accross time range calculations.
|
|
| get_calculation_outcome ($value, $subtype=false) |
| get_calculation_outcome
|
|
| get_display_value ($value, $subtype=false) |
| get_display_value
|
|
| get_id () |
| The class id is the calculable class full qualified class name.
|
|
| save_calculation_info (\core_analytics\local\time_splitting\base $timesplitting, int $rangeindex) |
| Stores in MUC the previously added data and it associates it to the provided $calculable.
|
|
| should_be_displayed ($value, $subtype) |
| Show only the main feature.
|
|
|
const | MAX_VALUE = 1 |
| Max value an indicator can return.
|
|
const | MIN_VALUE = -1 |
| Min value an indicator can return.
|
|
const | OUTCOME_NEGATIVE = 3 |
| Negative calculation outcome.
|
|
const | OUTCOME_NEUTRAL = 0 |
| Neutral calculation outcome.
|
|
const | OUTCOME_OK = 2 |
| Positive calculation outcome.
|
|
const | OUTCOME_VERY_NEGATIVE = 4 |
| Very negative calculation outcome.
|
|
const | OUTCOME_VERY_POSITIVE = 1 |
| Very positive calculation outcome.
|
|
|
| add_shared_calculation_info (int $sampleid, array $info) |
| Adds info related to the current calculation for later use when generating insights.
|
|
| classify_value ($value, $ranges) |
| Classifies the provided value into the provided range according to the ranges predicates.
|
|
| get_cognitive_indicator ($modname) |
| Returns the cognitive depth class of this indicator.
|
|
| get_time_range_weeks_number ($starttime, $endtime) |
| Returns the number of weeks a time range contains.
|
|
| limit_value ($calculatedvalue) |
| Limits the calculated value to the minimum and maximum values.
|
|
| retrieve ($elementname, $sampleid) |
| Retrieve the specified element associated to $sampleid.
|
|
| to_features ($calculatedvalues) |
| Converts the calculated values to a list of features for the dataset.
|
|
| validate_calculated_value ($calculatedvalue) |
| Validates the calculated value.
|
|
|
static | include_averages () |
| Set to false to avoid context features to be added as dataset features.
|
|
|
core_analytics calculation_info null | $calculationinfo = null |
|
array[] | $sampledata = array() |
|
Potential cognitive depth indicator.
It extends linear instead of discrete as there is a linear relation between the different cognitive levels activities can reach.
- Copyright
- 2017 David Monllao
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ add_sample_data()
core_analytics\calculable::add_sample_data |
( |
| $data | ) |
|
|
inherited |
add_sample_data
- Parameters
-
- Return values
-
◆ add_shared_calculation_info()
core_analytics\calculable::add_shared_calculation_info |
( |
int | $sampleid, |
|
|
array | $info ) |
|
finalprotectedinherited |
Adds info related to the current calculation for later use when generating insights.
Note that the data in $info array is reused across multiple samples, if you want to add data just for this sample you can use the sample id as key.
Please, note that you should be careful with how much data you add here as it can kill the server memory.
- Parameters
-
int | $sampleid | The sample id this data is associated with |
array | $info | The data. Indexed by an id unique across the site. E.g. an activity id. |
- Return values
-
◆ calculate()
core_analytics\local\indicator\base::calculate |
( |
| $sampleids, |
|
|
| $samplesorigin, |
|
|
| $starttime = false, |
|
|
| $endtime = false, |
|
|
| $existingcalculations = array() ) |
|
inherited |
Calculates the indicator.
Returns an array of values which size matches $sampleids size.
- Parameters
-
int[] | $sampleids | |
string | $samplesorigin | |
integer | $starttime | Limit the calculation to this timestart |
integer | $endtime | Limit the calculation to this timeend |
array | $existingcalculations | Existing calculations of this indicator, indexed by sampleid. |
- Return values
-
array | [0] = [$sampleid => int[]|float[]], [1] = [$sampleid => int|float], [2] = [$sampleid => $sampleid] |
◆ calculate_sample()
core_course\analytics\indicator\potential_cognitive_depth::calculate_sample |
( |
| $sampleid, |
|
|
| $sampleorigin, |
|
|
| $notusedstarttime = false, |
|
|
| $notusedendtime = false ) |
calculate_sample
- Exceptions
-
- Parameters
-
int | $sampleid | |
string | $sampleorigin | |
int | false | $notusedstarttime | |
int | false | $notusedendtime | |
- Return values
-
Reimplemented from core_analytics\local\indicator\base.
◆ classify_value()
core_analytics\calculable::classify_value |
( |
| $value, |
|
|
| $ranges ) |
|
protectedinherited |
Classifies the provided value into the provided range according to the ranges predicates.
Use:
- eq as 'equal'
- ne as 'not equal'
- lt as 'lower than'
- le as 'lower or equal than'
- gt as 'greater than'
- ge as 'greater or equal than'
- Exceptions
-
- Parameters
-
int | float | $value | |
array | $ranges | e.g. [ ['lt', 20], ['ge', 20] ] |
- Return values
-
◆ clear_sample_data()
core_analytics\calculable::clear_sample_data |
( |
| ) |
|
|
inherited |
clear_sample_data
- Return values
-
◆ fill_per_analysable_caches()
Hook to allow indicators to pre-fill data that is shared accross time range calculations.
Useful to fill analysable-dependant data that does not depend on the time ranges. Use instance vars to cache data that can be re-used across samples calculations but changes between time ranges (indicator instances are reset between time ranges to avoid unexpected problems).
You are also responsible of emptying previous analysable caches.
- Parameters
-
- Return values
-
Reimplemented in core_analytics\local\indicator\community_of_inquiry_activity.
◆ get_calculation_outcome()
core_analytics\local\indicator\linear::get_calculation_outcome |
( |
| $value, |
|
|
| $subtype = false ) |
|
inherited |
◆ get_cognitive_indicator()
core_course\analytics\indicator\potential_cognitive_depth::get_cognitive_indicator |
( |
| $modname | ) |
|
|
protected |
Returns the cognitive depth class of this indicator.
- Parameters
-
- Return values
-
core_analytics\local\indicator\base|false | |
◆ get_display_value()
core_analytics\local\indicator\linear::get_display_value |
( |
| $value, |
|
|
| $subtype = false ) |
|
inherited |
◆ get_feature_headers()
static core_analytics\local\indicator\linear::get_feature_headers |
( |
| ) |
|
|
staticinherited |
get_feature_headers
- Return values
-
◆ get_id()
core_analytics\calculable::get_id |
( |
| ) |
|
|
inherited |
The class id is the calculable class full qualified class name.
- Return values
-
◆ get_max_value()
static core_analytics\local\indicator\base::get_max_value |
( |
| ) |
|
|
staticinherited |
Returns the maximum value an indicator calculation can return.
- Return values
-
◆ get_min_value()
static core_analytics\local\indicator\base::get_min_value |
( |
| ) |
|
|
staticinherited |
Returns the minimum value an indicator calculation can return.
- Return values
-
◆ get_name()
static core_course\analytics\indicator\potential_cognitive_depth::get_name |
( |
| ) |
|
|
static |
◆ get_time_range_weeks_number()
core_analytics\calculable::get_time_range_weeks_number |
( |
| $starttime, |
|
|
| $endtime ) |
|
protectedinherited |
Returns the number of weeks a time range contains.
Useful for calculations that depend on the time range duration. Note that it returns a float, rounding the float may lead to inaccurate results.
- Parameters
-
int | $starttime | |
int | $endtime | |
- Return values
-
◆ include_averages()
static core_analytics\local\indicator\linear::include_averages |
( |
| ) |
|
|
staticprotectedinherited |
Set to false to avoid context features to be added as dataset features.
- Return values
-
◆ instance()
static core_analytics\local\indicator\base::instance |
( |
| ) |
|
|
staticinherited |
Returns an instance of the indicator.
Useful to reset cached data.
- Return values
-
◆ limit_value()
core_analytics\calculable::limit_value |
( |
| $calculatedvalue | ) |
|
|
protectedinherited |
Limits the calculated value to the minimum and maximum values.
- Parameters
-
- Return values
-
◆ required_sample_data()
static core_course\analytics\indicator\potential_cognitive_depth::required_sample_data |
( |
| ) |
|
|
static |
◆ retrieve()
core_analytics\calculable::retrieve |
( |
| $elementname, |
|
|
| $sampleid ) |
|
protectedinherited |
Retrieve the specified element associated to $sampleid.
- Parameters
-
string | $elementname | |
int | $sampleid | |
- Return values
-
stdClass|false | An stdClass object or false if it can not be found. |
◆ save_calculation_info()
Stores in MUC the previously added data and it associates it to the provided $calculable.
Flagged as final as we don't want people to extend this, it is likely to be moved to core_analytics\calculable
- Parameters
-
- Return values
-
◆ should_be_displayed()
core_analytics\local\indicator\linear::should_be_displayed |
( |
| $value, |
|
|
| $subtype ) |
|
inherited |
◆ to_features()
core_analytics\local\indicator\linear::to_features |
( |
| $calculatedvalues | ) |
|
|
protectedinherited |
◆ validate_calculated_value()
core_analytics\local\indicator\base::validate_calculated_value |
( |
| $calculatedvalue | ) |
|
|
protectedinherited |
The documentation for this class was generated from the following file:
- course/classes/analytics/indicator/potential_cognitive_depth.php