read_dataset_excel: Read data set from excel files

View source: R/read_dataset_excel.R

read_dataset_excelR Documentation

Read data set from excel files

Description

read_dataset_excel reads the raw data set from multiple excel files into a data frame with the correct settings.

Usage

read_dataset_excel(
  lessons = NULL,
  file_response = NULL,
  file_lesson = NULL,
  file_fact = NULL,
  file_dir = NULL,
  exampleset = FALSE
)

Arguments

lessons

A vector that contains the lesson ID's that should be parsed.

file_response

Excel file with response entries.

file_lesson

Excel file with lesson data.

file_fact

Excel file with fact data.

file_dir

Directory that contains the excel files ending on "fact.xlsx", "lesson.xlsx" and "response.xlsx".

exampleset

If TRUE the example data set will be used and no excel files need to be provided. The default is FALSE, and either a directory or a set of 3 files need to be provided.

Details

Three files need to be provided to parse the excel files correctly. These are the files containing the responses, the lesson data and the fact data. The file path to these files can either be provided individually or a directory containing these files can be provided. If a directory is provided the files must end on "fact.xlsx", "lesson.xlsx" and "response.xlsx" to be recognized. Only one file ending on each of these strings should be present in the directory, otherwise the wrong files may be selected.

If one of your files is placed in a different directory or does not end on the correct string, it is necessary to provide all three files with their individual file path and to not provide a directory.

Value

A data table. The output has the following properties:

  • The information contained in the data column from the response file is separated into individual columns. Except for properties that contain objects, which are not parsed.

  • All other data from the response file is preserved. From the lesson file the lesson title is added to the response entries. From the fact file the fact text and fact answer is added to the response entries.

  • A presentationStartTime is added to reset entries (with factId -1), which do not represent the time at which the reset was performed, but do represent the sequence of the entries.


VanRijnLab/SlimStampeRData documentation built on July 26, 2022, 7:31 p.m.