Stata 15 help for mf_st_matrix_list

Title

[M-5] st_matrix_list() -- Listing a Stata matrix

Syntax

void st_matrix_list(name)

void st_matrix_list(name, format, title, blank, half, header, names, dotz)

where

name: string scalar format: string scalar title: string scalar blank: real scalar half: real scalar header: real scalar names: real scalar dotz: real scalar

Description

st_matrix_list(name) lists the contents of Stata matrix name. The other optional arguments control how st_matrix_list() produces output.

format specifies the numeric format for displaying the elements of Stata matrix name. The default is "%10.0g".

title is added to the header displayed before the matrix contents. The default is "".

blank indicates whether to add a blank line before displaying the matrix contents. The default is 1.

half indicates whether to display symmetric matrices in lower triangular form. The default is 1.

header indicates whether to display the header. The header consists of the matrix name, its dimensions, the optional title, and whether the matrix is symmetric. The default is 1.

names indicates whether to display the row and column names around the matrix. The default is 1.

dotz indicates whether to display .z missing values. If dotz==0, st_matrix_list() displays .z missing values as blanks. The default is 1.

Conformability

st_matrix_list(name, format, title, blank, half, header, names, dotz) name: 1 x 1 format: 1 x 1 (optional) title: 1 x 1 (optional) blank: 1 x 1 (optional) half: 1 x 1 (optional) header: 1 x 1 (optional) names: 1 x 1 (optional) dotz: 1 x 1 (optional) result: void

Diagnostics

st_matrix_list(name) aborts with error if any of its arguments are malformed.

Source code

st_matrix_list.mata


© Copyright 1996–2018 StataCorp LLC   |   Terms of use   |   Privacy   |   Contact us   |   What's new   |   Site index