combined_dataset {ouladFormat}R Documentation

Returns the combined formatted OULAD

Description

Combines multiple OULAD .csv files into one tibble that is formatted for data analysis and where each row represents a unique student.

Usage

combined_dataset(
  module = c("AAA", "BBB", "CCC", "DDD", "EEE", "FFF", "GGG"),
  presentation = c("2013J", "2014J", "2013B", "2014B", "All"),
  repeat_students = c("remove", "keep"),
  withdrawn_students = c("remove", "keep"),
  demographics = FALSE,
  registration = FALSE,
  VLE = c("omit", "daily", "weekly", "activity", "FSLM", "FSLSM", "OLS", "VARK"),
  VLE_clicks = c("total", "binary", "standardise1", "standardise2", "logarithmic"),
  week_begin = -4,
  week_end = 39,
  assessment = FALSE,
  na.rm = FALSE,
  example_data = FALSE
)

Arguments

module

name of the module to be included, either "AAA", "BBB", "CCC", "DDD", "EEE", "FFF" or "GGG".

presentation

name of the semester of the module to be included, either "2013B", "2014B", "2013J", "2014J", or "All". "B" indicates a February start time whereas "J" indicates an October start time. "All" indicates that all presentations of the module will be included in the returned data.

repeat_students

indicator of whether students who had previous attempts at the module should be removed, either "remove" or "keep". When presentation is set to "All", this value is set to "remove".

withdrawn_students

indicator of whether students who had withdrawn from the module should be removed, either "remove" or "keep". Students are removed based on whether they have withdrawn by the "week_end" value.

demographics

logical. Indicates whether demographic data is included in the outputted data set.

registration

logical. Indicates whether registration data is included in the outputted data set.

VLE

indicates whether VLE data is included in the outputted data set (default is "omit" - VLE data not to be included). If included, the VLE data can be returned based on "weekly" VLE interactions, "daily" VLE interactions or interactions according to Open University activities ("activity"). The VLE data can also be returned as classified under a specific learning model, either "FSLM", "FSLSM", "OLS", or "VARK".

VLE_clicks

indicates the format that the VLE data should be returned as, either "total" views (default), "binary" views, "standardise1" (standardises each variable individually by using the scale function), "standardise2" (performs global standardisation of the data set), or "logarithmic" values.

week_begin

the first semester week of VLE and assessment data to be included in formatted data. Depending on the module presentation, students started to view activities four weeks prior to the initial module start date. Weeks prior to the initial module start are indicated by a negative integer.

week_end

the last semester week of VLE and assessment data to be included in the formatted data. Week 39 is the last week material was viewed (and earlier in some module presentations). This parameter is also used to remove withdrawn students.

assessment

logical. Indicates whether assessment data is included in the outputted data set.

na.rm

logical. Indicates whether NAs should be omitted from the average continuous assessment calculations or treated as zeroes (default). This calculation only includes continuous assessment that was due between the period set by "week_begin" and "week_end" inclusive, and only occurs when a specific module presentation is requested (e.g., 'BBB 2013J').

example_data

logical. Indicates whether to run a subset of the VLE data as an example.

Value

Returns the inputs specified for whether assessment, demographics, registration and VLE variables are to be included, as well as the other inputs. Also, one tibble (object of class tbl_df) is returned, dataset_combined.

dataset_combined tibble

A tibble where each row represents a unique student. Depending on the inputs specified, the tibble includes assessment, demographics, registration and VLE data for each student.

References

Kuzilek, J., Hlosta, M., & Zdrahal, Z. (2017). Open university learning analytics dataset. Scientific Data volume 4 , (pp. 1–8). https://doi.org/10.1038/sdata.2017.171.

See Also

For more information on different inputs and variables in the dataset_combined tibble, see:

Examples

# Uses subset of the VLE data set for example
combined_dataset(module = "AAA", presentation = "2013J",
repeat_students = "remove", withdrawn_students = "remove",
demographics = TRUE, registration = TRUE,
assessment = TRUE, na.rm = FALSE,
VLE = "weekly", VLE_clicks = "total",
example_data = TRUE)

# Slow to run as it loads the full VLE data set
combined_dataset(module = "BBB", presentation = "2013J",
repeat_students = "remove", withdrawn_students = "remove",
demographics = TRUE, registration = FALSE,
assessment = TRUE, na.rm = FALSE,
VLE = "activity", VLE_clicks = "standardise1",
week_begin = -4, week_end = 14, example_data = FALSE)

[Package ouladFormat version 1.1.2 Index]