Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: at-risk dashboard documentation update #287

Merged
merged 2 commits into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/_static/atrisk_engagement.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/atrisk_enrollment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/atrisk_learner_dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/atrisk_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 26 additions & 11 deletions docs/reference/learner_groups_dashboard.rst
Original file line number Diff line number Diff line change
@@ -1,35 +1,50 @@
At-Risk Learner Dashboard Reports
#################################

In the At-Risk Learner Dashboard Reports, you can review the learners' performance to gain a clear perspective of their engagement and performance in the course and identify those at risk of abandoning or dropping the course. Learners who appear in this dashboard have enrolled in the course, have done something in the course other than visit the course homepage, have not yet passed the course, and have not visited the course in seven or more days.
In the At-Risk Learner Dashboard Reports, you can review the learners performance to gain a clear perspective of their engagement and performance in the course and identify those at risk of abandoning or dropping the course. Learners who appear in this dashboard have enrolled in the course, have done something other than visit the course homepage, have not yet passed the course, and have not visited the course in seven or more days.

The charts of this dashboard apply cross-filters to charts whose data sets contain the same name.
The charts of this dashboard apply cross-filters to charts whose data sets contain the same name.

.. image:: /_static/at_risk_dashboard.png
.. image:: /_static/atrisk_learner_dashboard.png

At the top of this dashboard, you will find five tabs: **Overview**, **Enrollment**, **Engagement**, **Performance**, and **Help**. Each tab shows different information you can filter, choosing one particular learner to understand their behavior and take any necessary action to intervene.

In the tabs, you will find:

- **Overview:** In this tab, you will find the list of learners with names, usernames, and emails above the last visit date to have a first metric to indicate a risk factor. If you select one user in this tab, that selection will filter the information of the rest of the tabs to show only the information linked to that user. If the name, username, and email address columns are empty, it is because your site operator has chosen to omit limited personally identifiable information from being displayed on your Open edX instance.
Overview
--------
In this tab, you will find the list of learners with names, usernames, and emails above the last visit date to have a first metric to indicate a risk factor. If you select one user in this tab, that selection will filter the information of the rest of the tabs to show only the information linked to that user. Suppose the name, username, and email address columns are empty. In that case, your site operator has omitted limited personally identifiable information from being displayed on your Open edX instance.

- **Enrollment:** This tab has data on enrollment type and date.
.. image:: /_static/atrisk_overview.png

.. image:: /_static/at_risk_dashboard.png

Enrollment
----------
This tab shows the number of enrollees by enrollment track and enrollment dates.

- **Engagement:** This tab contains a detailed report about the learners' interaction with the course content, particularly with the pages, problems, and videos. This tab will give you relevant information about the troubles the at-risk learner group has with the content in case you need to create an alternative route for them.
.. image:: /_static/atrisk_enrollment.png


Engagement
----------
This tab contains a detailed report about the learners' interaction with the course content, particularly with the pages, problems, and videos. This tab will give you relevant information about the troubles the at-risk learner group has with the content in case you need to create an alternative route for them.

.. image:: /_static/atrisk_engagement.png


- **Performance:** This tab shows the course grades as a metric of the learner's performance to indicate the approval percentage.
Performance
-----------
This tab shows the course grades as a metric of the learner’s performance, indicating the approval percentage and the distribution of course grades.

.. image:: /_static/atrisk_performance.png


- **Help:** It takes you to the tool documentation.
Help
----
The Help tab at the bottom of the course dashboard is a valuable resource for users seeking assistance or additional information. It typically provides quick access to relevant documentation and support materials related to the course and the platform.

.. image:: /_static/help_tab.png

.. note::Remember that you can change the filters of these reports by accessing Superset through the link above the reports. For more information, visit the How-tos section.
.. note:: Remember that you can change the filters of these reports by accessing Superset through the link above the reports. For more information, visit the `How to Apply Filters page <https://docs.openedx.org/projects/openedx-aspects/en/latest/course_team/how-tos/apply_filters.html>`_.

.. seealso::If you want to refresh the information displayed in the report, click the **More Options** button (three vertical dots) in the upper right corner of each metric and select the Force Refresh option. For more information, visit the How-tos section.
.. seealso:: If you want to refresh the information displayed in the report, click the **More Options** button (three vertical dots) in the upper right corner of each metric and select the **Force Refresh** option. For more information, visit the `How to Update the Data <https://docs.openedx.org/projects/openedx-aspects/en/latest/course_team/how-tos/update_data.html>`_.