lvar: Getting variables

In remnrem/luna: Analysis of Sleep Signal Data

Getting variables

Description

Returns the value of a user-defined variable

Usage

lvar(v)

Arguments

v	a required parameter, the variable name

Value

the variable value, or NULL if the variable is not defined, or if it is a special variable (e.g. sig or alias)

Note

The lvar() function only applies to user-defined variables such as ${stage}. Special variables (e.g. sig, annots, etc) will currently return NULL here.

> lvar("sig")
NULL

This doesn't mean they are not defined. Whilst not a bug exactly, this "feature" is not particularly convenient; future releases of lunaR will be fixed to return the actual values of all variables.

Examples

## Not run: 
> lvar("stage")
[1] "N2"

## End(Not run)

remnrem/luna documentation built on June 1, 2025, 2:14 p.m.