simbase_labeler {WoodSimulatR}

Default labelling function for simbase objects

Description

Each simbase object should have a label which can be used for differentiating different simulations. This function tries to simplify the label generation.

Usage

simbase_labeler(data, simbase_class, transforms)

Arguments

data

The dataset for the calculation of the basic simulation data.

simbase_class

The class of the simbase object for which the label is to be generated. Currently, only "simbase_covar" is supported.

transforms

The transforms applied to variables in the dataset. Must be objects of class trans or class transform (see function trans_new in package scales).

Details

Primarily, this function is intended to be called as a default from simbase_covar. It can also serve as a template for creating custom labelling functions.

Value

A string for labelling a simbase object.