process_auxiliary: Processing functions for all auxiliary (non-response) data.

process_auxiliaryR Documentation

Processing functions for all auxiliary (non-response) data.

Description

These functions are for individually processing the auxiliary components of a CourseKata data download. These functions assume that you are working files downloaded from CourseKata, as these files have a predictable structure.

Usage

process_classes(object, class_id = NULL, convert_json = FALSE)

process_page_views(object, time_zone = "UTC", class_id = NULL)

process_media_views(
  object,
  time_zone = "UTC",
  class_id = NULL,
  convert_json = FALSE
)

process_items(object, class_id = NULL, convert_json = FALSE)

process_tags(object, class_id = NULL)

Arguments

object

The object to process the data from. This can be one of a variety of options:

  • the path(s) to a CourseKata data download zip file or the directory extracted from that zip

  • the path(s) to a specific CSV file (e.g. classes.csv)

  • a data.frame

class_id

(Optional) A character vector of the IDs of specific classes you want to extract data for. These values should correspond to the names of the directories where the desired CSV files can be found in the original data download.

convert_json

For speed of processing, columns containing JSON are just read in as strings. If you are going to use these data, it may be useful to convert them to lists by specifying this argument as TRUE.

time_zone

The time zone to use when parsing date-time objects (see timezones).

Details

with a zip archive as downloaded from CourseKata, a directory extracted from said zip archive, the path to the specif

Value

These functions will always return a tibble of the data you are processing. Each row of the resulting tibble, describes the type of data named by the function, e.g. process_classes() returns a tibble with rows describing classes. For descriptions of each of variables in each of the tables, see the README for this package (included in the data download or online at https://github.com/UCLATALL/CourseKataData).

See Also

Other processing functions: process_responses()


UCLATALL/CourseKataData documentation built on Dec. 4, 2023, 2:25 a.m.