xlabel: Extract and set labels for Xpose data items.

View source: R/xlabel.R

xlabelR Documentation

Extract and set labels for Xpose data items.

Description

This function extracts and sets label definitions in Xpose data objects.

Usage

xlabel(x, object)

xlabel(object) <- value

Arguments

x

Name of the variable to assign a label to.

object

An xpose.data object.

value

A two element vector of which the first element is the name of the variable and the second the label

Details

x should be a string exactly matching the name of a column in the data.frame in the Data slot of an xpose.data object. The name of columns defined through xpose variable definitions (see xpose.data) can be extracted using the xvardef function and to be used in the xlabel function, e.g. xlabel(xvardef("dv",object),object), which would give the label for the dv variable.

Value

The label of the specified column.

Functions

  • xlabel(object) <- value: sets label definitions in Xpose data objects. assigned value should be a two-element vector of which the first element is the name of the variable and the second the label

Author(s)

Niclas Jonsson

See Also

xpose.prefs-class, xvardef

Other data functions: add_transformed_columns, change_graphical_parameters, change_misc_parameters, compute.cwres(), data.checkout(), data_extract_or_assign, db.names(), export.graph.par(), export.variable.definitions(), import.graph.par(), import.variable.definitions(), make.sb.data(), nsim(), par_cov_summary, read.TTE.sim.data(), read.nm.tables(), read_NM_output, read_nm_table(), simprazExample(), tabulate.parameters(), xpose.data, xpose.print(), xpose4-package, xsubset()

Examples


xpdb <- simpraz.xpdb

## Display label for dependent variable in the Xpose data object
xlabel("DV", xpdb)

## Set label for dependent variable
xlabel(xpdb) <- c("DV", "Concentration (mg/L)")
xlabel("DV", xpdb) # how has this chnaged?

xpose4 documentation built on May 29, 2024, 7:56 a.m.