ds.mxMatrix: Creates a new MxMatrix object

Description Usage Arguments Details Value Author(s) References Examples

Description

This function is similar to OpenMx function mxMatrix.

Usage

1
2
3
ds.mxMatrix(type = "Full", nrow = NA, ncol = NA, free = FALSE,
  values = NA, labels = NA, lbound = NA, ubound = NA, byrow = FALSE,
  dimnames = NA, name = NA, newobj = "new_mxMatrix", datasources = NULL)

Arguments

type

a character string indicating the matrix type, where type indicates the range of values and #' equalities in the matrix. Must be one of: 'Diag', 'Full', 'Iden', 'Lower', 'Sdiag', 'Stand', 'Symm', 'Unit', or 'Zero'.

nrow

the desired number of rows. One or both of 'nrow' and 'ncol' is required when 'values', 'free', 'labels', 'lbound', and 'ubound' arguments are not matrices, depending on the matrix type.

ncol

the desired number of columns. One or both of 'nrow' and 'ncol' is required when 'values', 'free', 'labels', 'lbound', and 'ubound' arguments are not matrices, depending on the matrix type.

free

a vector or matrix of logicals for free parameter specification. A single 'TRUE' or 'FALSE' will set all allowable variables to free or fixed, respectively.

values

a vector or matrix of numeric starting values. By default, all values are set to zero.

labels

a vector or matrix of characters for variable label specification.

lbound

a vector or matrix of numeric lower bounds. Default bounds are specified with an NA.

ubound

a vector or matrix of numeric upper bounds. Default bounds are specified with an NA.

byrow

logical. If 'FALSE' (default), the 'values', 'free', 'labels', 'lbound', and 'ubound' matrices are populated by column rather than by row.

dimnames

list. The dimnames attribute for the matrix: a list of length 2 giving the row and column names respectively. An empty list is treated as NULL, and a list of length one as row names. The list can be named, and the list names will be used as names for the dimensions.

name

an optional character string indicating the name of the MxMatrix object

newobj

the name of the new object. By default the name of the new object is "new_mxMatrix".

datasources

a list of opal object(s) obtained after login in to opal servers; these objects hold also the data assign to R, as dataframe, from opal datasources. By default an internal function looks for 'opal' objects in the environment and sets this parameter.

Details

See details of the OpenMx function 'mxMatrix' in the package OpenMx.

Value

a new mxMatrix object, which consists of a 'values' matrix of numeric starting values, a 'free' matrix describing free parameter specification, a 'labels' matrix of labels for the variable names, and 'lbound' and 'ubound' matrices of the lower and upper parameter bounds.

Author(s)

Gaye, A.

References

Steven M. Boker, Michael C. Neale, Hermine H. Maes, Michael J. Wilde, Michael Spiegel, Timothy R. Brick, Jeffrey Spies, Ryne Estabrook, Sarah Kenny, Timothy C., Bates, Paras Mehta, and John Fox. (2011) OpenMx: An Open Source Extended Structural Equation Modeling Framework. Psychometrika. Steven M. Boker, Michael C. Neale, Hermine H. Maes, Michael J. Wilde, Michael Spiegel, Timothy R. Brick, Ryne Estabrook, Timothy C. Bates, Paras Mehta, Timo von Oertzen, Ross J. Gore, Michael D. Hunter, Daniel C. Hackett, Julian Karch and Andreas M. Brandmaier. (2012) OpenMx 1.3 User Guide.

Examples

1
2
3
{

}

datashield/dsMxClient documentation built on May 14, 2019, 7:51 p.m.