R: Rename a model or submodel

mxRename {OpenMx} | R Documentation

## Rename a model or submodel

### Description

This function re-names a model. By default, the top model will be renamed. To rename a specific model, set oldname (see examples). Importantly, all internal references to the old model name (e.g. in algebras) will be updated to reference the new name.

### Usage

    mxRename(model, newname, oldname = NA)

### Arguments

`model` | a MxModel object.
`newname` | the new name of the model.
`oldname` | the name of the target model to rename. If NA then rename top model.

### Value

Return a mxModel object with the target model renamed.

### References

The OpenMx User's guide can be found at https://openmx.ssri.psu.edu/documentation/.

### Examples

    library(OpenMx)

    # Create a parent model with two submodels:
    modelC <- mxModel(model= 'modelC',
    	mxModel(model= 'modelA'),
    	mxModel(model= 'modelB')
    )

    # Rename modelC (the top model) to "model1"
    model1 <- mxRename(modelC, 'model_1')

    # Rename submodel "modelB" to "model_2"
    model1 <- mxRename(model1, oldname = 'modelB', newname = 'model_2')

    model1

[Package OpenMx version 2.20.6 Index]