getVariableValues: Obtain variable overview

View source: R/deprecated.R

getVariableValuesR Documentation

Obtain variable overview

Description

If the variable denoted in variable_name is categorical (character or factor) all unique values/levels are returned. If the variable is numeric it is given to psych::describe() which returns a statistical summary.

Usage

getVariableValues(object, phase = NULL, variable_name)

Arguments

object

A valid cypro object.

phase

Character or numeric. If character, the ordinal value referring to the phase of interest (e.g. 'first', 'second' etc.). referring to the phase of interest or 'all'. If numeric, the number referring to the phase.

If set to NULL takes the phase denoted as default with adjustDefault().

Ignored if the experiment design contains only one phase.

variable_name

Character value. Denotes the variable of interest. Valid inputs can be obtained via the function getVariableNames().

Value

A character vector or a data.frame of one row containing basic descriptive statistics.


theMILOlab/cypro documentation built on April 5, 2022, 2:03 a.m.