Skip to content

Commit

Permalink
MDL-64636 analytics: new course_completion target
Browse files Browse the repository at this point in the history 
Added new target to predict which students are at risk of not meeting
the course completion criteria.
  • Loading branch information
@vmdef
vmdef committed Mar 29, 2019
1 parent 48ac554 commit 03fce0a
Show file tree
Hide file tree
Showing 3 changed files with 368 additions and 0 deletions.
4 changes: 4 additions & 0 deletions lang/en/moodle.php
View file
Expand Up @@ -1970,10 +1970,14 @@
$string['tagalready'] = 'This tag already exists';
$string['tagmanagement'] = 'Add/delete tags ...';
$string['tags'] = 'Tags';
$string['target:coursecompletion'] = 'Students at risk of not meeting the course completion conditions';
$string['target:coursecompletion_help'] = 'This target describes whether the student is considered at risk of not meeting the course completion conditions.';
$string['target:coursedropout'] = 'Students at risk of dropping out';
$string['target:coursedropout_help'] = 'This target describes whether the student is considered at risk of dropping out.';
$string['target:noteachingactivity'] = 'No teaching';
$string['target:noteachingactivity_help'] = 'This target describes whether courses due to start in the coming week will have teaching activity.';
$string['targetlabelstudentcompletionno'] = 'Student who is likely to meet the course completion conditions';
$string['targetlabelstudentcompletionyes'] = 'Student at risk of not meeting the course completion conditions';
$string['targetlabelstudentdropoutyes'] = 'Student at risk of dropping out';
$string['targetlabelstudentdropoutno'] = 'Not at risk';
$string['targetlabelteachingyes'] = 'Users with teaching capabilities have access to the course';
Expand Down
109 changes: 109 additions & 0 deletions lib/classes/analytics/target/course_completion.php
View file
@@ -0,0 +1,109 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.

/**
* Course completion target.
*
* @package core
* @copyright 2019 Victor Deniz <victor@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

namespace core\analytics\target;

defined('MOODLE_INTERNAL') || die();

require_once($CFG->dirroot . '/course/lib.php');
require_once($CFG->dirroot . '/lib/completionlib.php');
require_once($CFG->dirroot . '/completion/completion_completion.php');

/**
* Course completion target.
*
* @package core
* @copyright 2019 Victor Deniz <victor@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class course_completion extends \core\analytics\target\course_enrolments {

/**
* Returns the name.
*
* If there is a corresponding '_help' string this will be shown as well.
*
* @return \lang_string
*/
public static function get_name() : \lang_string {
return new \lang_string('target:coursecompletion');
}

/**
* Returns descriptions for each of the values the target calculation can return.
*
* @return string[]
*/
protected static function classes_description() {
return array(
get_string('targetlabelstudentcompletionno'),
get_string('targetlabelstudentcompletionyes')
);
}

/**
* Discards courses that are not yet ready to be used for training or prediction.
*
* @param \core_analytics\analysable $course
* @param bool $fortraining
* @return true|string
*/
public function is_valid_analysable(\core_analytics\analysable $course, $fortraining = true) {
$isvalid = parent::is_valid_analysable($course, $fortraining);

if (is_string($isvalid)) {
return $isvalid;
}

// Not a valid target if completion is not enabled or there are not completion criteria defined.
$completion = new \completion_info($course->get_course_data());
if (!$completion->is_enabled() || !$completion->has_criteria()) {
return get_string('completionnotenabledforcourse', 'completion');
}

return true;
}

/**
* Course completion sets the target value.
*
* @param int $sampleid
* @param \core_analytics\analysable $course
* @param int $starttime
* @param int $endtime
* @return float 0 -> course not completed, 1 -> course completed
*/
protected function calculate_sample($sampleid, \core_analytics\analysable $course, $starttime = false, $endtime = false) {

$userenrol = $this->retrieve('user_enrolments', $sampleid);

// We use completion as a success metric.
$ccompletion = new \completion_completion(array('userid' => $userenrol->userid, 'course' => $course->get_id()));
if ($ccompletion->is_complete()) {
return 0;
} else {
return 1;
}
}
}
255 changes: 255 additions & 0 deletions lib/tests/targets_test.php
View file
@@ -0,0 +1,255 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.

/**
* Unit tests for core targets.
*
* @package core
* @category analytics
* @copyright 2019 Victor Deniz <victor@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

defined('MOODLE_INTERNAL') || die();
global $CFG;

require_once($CFG->dirroot . '/completion/criteria/completion_criteria.php');
require_once($CFG->dirroot . '/completion/criteria/completion_criteria_activity.php');

/**
* Unit tests for core targets.
*
* @package core
* @category analytics
* @copyright 2019 Victor Deniz <victor@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class core_analytics_targets_testcase extends advanced_testcase {

/**
* Provides course params for the {@link self::test_core_target_course_completion_analysable()} method.
*
* @return array
*/
public function analysable_provider() {

$now = new DateTime("now", core_date::get_server_timezone_object());
$year = $now->format('Y');
$month = $now->format('m');

return [
'coursenotyetstarted' => [
'params' => [
'enablecompletion' => 1,
'startdate' => mktime(0, 0, 0, 10, 24, $year + 1)
],
'isvalid' => get_string('coursenotyetstarted')
],
'coursenostudents' => [
'params' => [
'enablecompletion' => 1,
'startdate' => mktime(0, 0, 0, 10, 24, $year - 2),
'enddate' => mktime(0, 0, 0, 10, 24, $year - 1)
],
'isvalid' => get_string('nocoursestudents')
],
'coursenosections' => [
'params' => [
'enablecompletion' => 1,
'format' => 'social',
'students' => true
],
'isvalid' => get_string('nocoursesections')
],
'coursenoendtime' => [
'params' => [
'enablecompletion' => 1,
'format' => 'topics',
'enddate' => 0,
'students' => true
],
'isvalid' => get_string('nocourseendtime')
],
'courseendbeforestart' => [
'params' => [
'enablecompletion' => 1,
'enddate' => mktime(0, 0, 0, 10, 23, $year - 2),
'students' => true
],
'isvalid' => get_string('errorendbeforestart', 'analytics')
],
'coursetoolong' => [
'params' => [
'enablecompletion' => 1,
'startdate' => mktime(0, 0, 0, 10, 24, $year - 2),
'enddate' => mktime(0, 0, 0, 10, 23, $year),
'students' => true
],
'isvalid' => get_string('coursetoolong', 'analytics')
],
'coursealreadyfinished' => [
'params' => [
'enablecompletion' => 1,
'startdate' => mktime(0, 0, 0, 10, 24, $year - 2),
'enddate' => mktime(0, 0, 0, 10, 23, $year - 1),
'students' => true
],
'isvalid' => get_string('coursealreadyfinished'),
'fortraining' => false
],
'coursenotyetfinished' => [
'params' => [
'enablecompletion' => 1,
'startdate' => mktime(0, 0, 0, $month - 1, 24, $year),
'enddate' => mktime(0, 0, 0, $month + 2, 23, $year),
'students' => true
],
'isvalid' => get_string('coursenotyetfinished')
],
'coursenocompletion' => [
'params' => [
'enablecompletion' => 0,
'startdate' => mktime(0, 0, 0, $month - 2, 24, $year),
'enddate' => mktime(0, 0, 0, $month - 1, 23, $year),
'students' => true
],
'isvalid' => get_string('completionnotenabledforcourse', 'completion')
],
];
}

/**
* Provides enrolment params for the {@link self::test_core_target_course_completion_samples()} method.
*
* @return array
*/
public function sample_provider() {
$now = time();
return [
'enrolmentendbeforecourse' => [
'coursestart' => $now,
'courseend' => $now + (WEEKSECS * 8),
'timestart' => $now,
'timeend' => $now - DAYSECS,
'isvalid' => false
],
'enrolmenttoolong' => [
'coursestart' => $now,
'courseend' => $now + (WEEKSECS * 8),
'timestart' => $now - (YEARSECS + (WEEKSECS * 8)),
'timeend' => $now + (WEEKSECS * 8),
'isvalid' => false
],
'enrolmentstartaftercourse' => [
'coursestart' => $now,
'courseend' => $now + (WEEKSECS * 8),
'timestart' => $now + (WEEKSECS * 9),
'timeend' => $now + (WEEKSECS * 10),
'isvalid' => false
],
];
}

/**
* Test valid analysable conditions.
*
* @dataProvider analysable_provider
* @param mixed $courseparams Course data
* @param true|string $isvalid True when analysable is valid, string when it is not
* @param boolean $fortraining True if the course is for training the model
*/
public function test_core_target_course_completion_analysable($courseparams, $isvalid, $fortraining = true) {
global $DB;

$this->resetAfterTest(true);

try {
$course = $this->getDataGenerator()->create_course($courseparams);
} catch (moodle_exception $e) {
$course = $this->getDataGenerator()->create_course();
$courserecord = $courseparams;
$courserecord['id'] = $course->id;
unset($courserecord['students']);

$DB->update_record_raw('course', $courserecord);
$course = get_course($course->id);
}
$user = $this->getDataGenerator()->create_user();

if (!empty($courseparams['enablecompletion'])) {
$assign = $this->getDataGenerator()->create_module('assign', ['course' => $course->id, 'completion' => 1]);
$cm = get_coursemodule_from_id('assign', $assign->cmid);

$criteriadata = (object) [
'id' => $course->id,
'criteria_activity' => [
$cm->id => 1
]
];
$criterion = new completion_criteria_activity();
$criterion->update_config($criteriadata);
}

$target = new \core\analytics\target\course_completion();

// Test valid analysables.

if (!empty($courseparams['students'])) {
// Enroll user in course.
$this->getDataGenerator()->enrol_user($user->id, $course->id);
}

$analysable = new \core_analytics\course($course);
$this->assertEquals($isvalid, $target->is_valid_analysable($analysable, $fortraining));
}

/**
* Test valid sample conditions.
*
* @dataProvider sample_provider
* @param int $coursestart Course start date
* @param int $courseend Course end date
* @param int $timestart Enrol start date
* @param int $timeend Enrol end date
* @param boolean $isvalid True when sample is valid, false when it is not
*/
public function test_core_target_course_completion_samples($coursestart, $courseend, $timestart, $timeend, $isvalid) {

$this->resetAfterTest(true);

$courserecord = new stdClass();
$courserecord->startdate = $coursestart;
$courserecord->enddate = $courseend;

$user = $this->getDataGenerator()->create_user();
$course = $this->getDataGenerator()->create_course($courserecord);
$this->getDataGenerator()->enrol_user($user->id, $course->id, null, 'manual', $timestart, $timeend);

$target = new \core\analytics\target\course_completion();
$analyser = new \core\analytics\analyser\student_enrolments(1, $target, [], [], []);
$analysable = new \core_analytics\course($course);

$class = new ReflectionClass('\core\analytics\analyser\student_enrolments');
$method = $class->getMethod('get_all_samples');
$method->setAccessible(true);

list($sampleids, $samplesdata) = $method->invoke($analyser, $analysable);
$target->add_sample_data($samplesdata);
$sampleid = reset($sampleids);

$this->assertEquals($isvalid, $target->is_valid_sample($sampleid, $analysable));
}
}

0 comments on commit 03fce0a

Please sign in to comment.