README.md

Evalyzer

Lifecycle:
experimental CRAN
status

The goal of evalyzer, which is an unofficial package, is to provide several functions to extract user testing data from the Evalyzer platform quickly and easily.

Installation

You can install the development version of evalyzer like so:

library(devtools)

devtools::install_github("KevinFalzone/evalyzer")

Login

To extract the data you need first to authenticate to the Evalyzer platform using the auth() function.

session <- auth("my-username", "my-password")

Data Extraction

Several functions have been created to extract data:

Overview

The get_overview() function retrieves a glimpse of the user tests. The table contains for each user:

session <- auth("my-username", "my-password")

user_overview <- get_overview(session, "project-id")

Configuration

The get_configuration() function extracts for each user the setup information. The table contains for each user:

session <- auth("my-username", "my-password")

user_configuration <- get_configuration(session, "project-id")

Behaviors

The get_behavior() function extracts for each user, the behaviors he performed during each task.

session <- auth("my-username", "my-password")

user_behavior <- get_behavior(session, "project-id")

Performances

The get_performance() function retrieves for each user, the duration and status of the task and sums the performances data from the get_behavior() function.

session <- auth("my-username", "my-password")

user_performance <- get_performance(session, "project-id")

Answers

The get_answer()function extracts the answers to the questions.

session <- auth("my-username", "my-password")

user_answer <- get_answer(session, "project-id")

Videos

The get_video()function permits to retrieve the videos for each task of each user.

session <- auth("my-username", "my-password")

get_video(session, "project-id", "path-to-store-files")


KevinFalzone/evalyzer documentation built on March 29, 2023, 10:58 p.m.