oulad/README.Rmd at main · data-edu/oulad · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
---
output: github_document
editor_options:
  markdown:
    wrap: 72
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# oulad

Data loaders for the **Open University Learning Analytics Dataset
(OULAD)**, packaged for convenient use in R.

This package provides a reproducible structure for working with the
seven core OULAD tables in efficient Parquet format, along with helper
functions for loading and filtering them.

## Installation

``` r
# Install from GitHub
# (requires remotes or devtools)
remotes::install_github("data-edu/oulad")

# Load the package
library(oulad)
```

## Data Overview

This package mirrors the original OULAD tables:

| Function                        | Description                                                   |
|-----------------------|-----------------------------|
| `oulad::assessments()`         | Assessment structure and key dates                            |
| `oulad::courses()`             | Module and presentation metadata                              |
| `oulad::studentAssessment()`   | Student submissions and assessment results                    |
| `oulad::studentInfo()`         | Demographics, age band, region, etc.                          |
| `oulad::studentRegistration()` | Student module registration records                           |
| `oulad::vle()`                 | Virtual Learning Environment (VLE) materials and release info |
| `oulad::studentVle()`          | **Large** log of student interactions with VLE materials      |

## How to Load the Data

```{r}
library(oulad)

assessments <- oulad::assessments()
courses <- oulad::courses()
student_assess <- oulad::studentAssessment()
student_info <- oulad::studentInfo()
student_reg <- oulad::studentRegistration()
vle <- oulad::vle()
student_vle <- oulad::studentVle()
```

## How to Join the Data

``` r
library(oulad)
library(dplyr)

students <- student_info %>%
    left_join(courses) %>%
    left_join(student_reg)

assessments <- student_assess %>%
    left_join(assessments)

interactions <- student_vle %>%
    left_join(vle) %>%
    left_join(courses)
```

## Developers

The raw OULAD CSV files are **not distributed** with this package
because of their size.\
To rebuild the Parquet files locally, first download the dataset from
the official OULAD site:

> **Download source:**\
> <https://analyse.kmi.open.ac.uk/open-dataset>

Then, place the CSVs under `data-raw/csv/` and run:

``` r
source("data-raw/make-extdata.R")
```

This script will convert the CSVs into compressed Parquet files under
`inst/extdata/` for fast access in R.\
These files are ignored by version control (see `.Rbuildignore`).

## Authors

-   **Joshua M. Rosenberg** – University of Tennessee, Knoxville\
-   **Kelly L. Boles** – University of Tennessee, Knoxville

## License & Citation

Data © The Open University, used under the terms of the [OULAD
license](https://analyse.kmi.open.ac.uk/open-dataset).

If you use this package or the data in research or teaching, please
cite:

> Kuzilek, J., Hlosta, M., & Zdrahal, Z. (2017).\
> *Open University Learning Analytics Dataset (OULAD).*\
> *Scientific Data*, 4, 170171.\
> <https://doi.org/10.1038/sdata.2017.171>

and

> Rosenberg, J. M., & Boles, K.L. (2025).\
> *oulad: Load and use the Open University Learning Analytics Dataset
> (OULAD).*\
> GitHub repository: <https://github.com/data-edu/oulad>