help statoutalso see: statsto, graphsto, graphout

Title

statout -- Formatting and saving matrices | 08June2012

Overview

statout formats the matrices matrix_names and optionally
saves them to files specified by file_names.
Matrices created by statsto or any other way can be changed.
If matrix_names is not specified, statout uses the names of matrices
in the global statsto_stored_matrices created by statsto.

For more information and examples, please visit the Collect Website.

General syntax

statout [matrix_names using file_names] [, options]

where matrix_names refers to one or more exiting matrices and file_names
refers to the name of the file where matrices will be saved.
If matrix_names is not specified, statout use matrix names stored by
statsto.

Table of contents

1. Row and column operations
2. Viewing and Formating
3. Matrix Utilities
4. Output
5. File formats for exporting files
6. Row and column lists

Options

Row and column operations

calpha Arrange columns in alphabetical order.

cdrop(list) Drop the columns in list.

ckeep(list) Keep only the columns in list.

cnumber The column number followed by underscore is added to column names.
For example, if the column is named M1 it would be renamed 1_M1.

corder(list) Columns are reordered to match list.

crename(new_name#=old_name#...) Rename column old_name# to
new_name#.

The commands ralpha, rdrop, rkeep, rnumber,
rorder, and rrename operate on rows.

Viewing and formatting

list Display matrix_name.

preview Display collect_matrix showing what the
matrix would like like after the current statistics are collected.
Those changes are not saved.

decimal(numlist) Set the number of decimal digits
for each column when listing the matrix.
Columns can have different numbers of decimal digits.
For example, statsto, list decimal(3 2).

format(string) Indicate the format to use for each
column when listing the matrix.
For example, statsto, list format(%9.2e %12.4e).

width(number) Specify the width of all columns.

title(title_string) Add a title to the matrix
when it is listed or saved.

transpose Temporarily transpose the matrix
before it is displayed.
If combined with save(new_name), the transposed matrix is saved
as new_name.

alignment(center | c | right | r | left | l) Center, right, or
left align columns in matrix when it is written to a file.

note(note_string) Add a note at the bottom of each
matrix that is saved.

nocount Do not add "Table #" before matrix

basecount(numlist) Specify what # "Table #" starts with

Matrix utilities

blank Add a blank row to matrix_name.

clear Remove the matrices from memory.

generate(column_list | column# [_all])
Variables are generated from the columns in matrix_name; _all selects all columns.

genstub(gen_stub)
Variables are named gen_stub+column_name.

save(new_matrix_name) Save collect_matrix as a
matrix named new_matrix_name.

transpose Temporarily transpose matrix_name.
If combined with save(), the transposed matrix is saved.

Output

replace Overwrite an existing file

append Append the output to an existing file

placement(string) Adjust the placement of
a float in an exported TeX file.

string Table is placed at:

t the top of the page

b the bottom of the page

p a special page for floats only

H precise location in text (requires "float" package)

document Adds \documentclass, \usepackage,
and \begin to the begining of a TeX document and
\end to the end of the document.

label(string) Adds \label{string} to a
TeX file.
This option turns tables into floats.

File formats for exporting files

statout formats and saves matrices to a text file specified by
using file_name, where .extension can be ".rtf" for RTF,
".html" for HTML, or ".tex" for TEX files. The .extension for file names
must be specified.
The file format can be RTF, TEX, HTML and must be specified in
.extension of file_name.

.rtf produces a Rich Text Format file for use with word processors.

.html produces a HTML formatted file.

.tex produces a LaTeX formatted file.

Row and column lists

You can specify columns using column indices or column names.
For example, to specify the 1st, 7th and 4th columns, use: 1 7 4.
Assuming the columns are named Col#,
you can select the same columns as: Col1 Col7 Col4.
You can mix names and numbers: 1 7 Col4.
Adjacent columns can be selected using a dash.
For example, to select columns 3 through 9, you could use:
3-9 or Col3-Col9 or Col3-9 or 3-Col9.
The abbreviation _all selects all columns.
The same methods can be used to select rows.
For example, Row10 Row1 3-5 Row7-8 9-Row13
translates into the indices 10 1 3 4 5 7 8 9 10 11 12 13

Authors

Joseph D. Wolfe , Indiana University, jdwolfe@indiana.edu

J. Scott Long, Indiana University, jslong@indiana.edu

Also see

Manual: [M] matrix

Website: Collect Website