Stata 15 help for log

[R] log -- Echo copy of session to file

Syntax

Report status of log file

log

log query [logname | _all]

Open log file

log using filename [, append replace [text|smcl] name(logname) nomsg]

Close log

log close [logname | _all]

Temporarily suspend logging or resume logging

log {off|on} [logname]

Report status of command log file

cmdlog

Open command log file

cmdlog using filename [, append replace]

Close command log, temporarily suspend logging, or resume logging

cmdlog {close|on|off}

Set default format for logs

set logtype {text|smcl} [, permanently]

Specify screen width

set linesize #

In addition to using the log command, you may access the capabilities of log by selecting File > Log from the menu and choosing one of the options in the list.

Menu

File > Log

Description

log and its subcommands tell Stata to open a log file and create a record of what you type and any output that appears in the Results window, to suspend or resume logging, to check logging status, and to close the log file. The default format is Stata Markup and Control Language (SMCL) but can be plain text. You can have up to five SMCL and five text logs open at a time. cmdlog and its subcommands are similar to log but create a command log recording only what you type and can be only plain text. You can have only one command log open at a time.

set logtype and set linesize are commands to control system parameters that relate to logs.

Options for use with both log and cmdlog

append specifies that results be appended to an existing file. If the file does not already exist, a new file is created.

replace specifies that filename, if it already exists, be overwritten. When you do not specify either replace or append, the file is assumed to be new. If the specified file already exists, an error message is issued and logging is not started.

Options for use with log

text and smcl specify the format in which the log is to be recorded. The default is complicated to describe but is what you would expect:

If you specify the file as filename.smcl, the default is to write the log in SMCL format (regardless of the value of set logtype).

If you specify the file as filename.log, the default is to write the log in text format (regardless of the value of set logtype).

If you type filename without an extension and specify neither the smcl option nor the text option, the default is to write the file according to the value of set logtype. If you have not set logtype, then the default is SMCL. Also, the filename you specified will be fixed to read filename.smcl if a SMCL log is being created or filename.log if a text log is being created.

If you specify either the text or smcl option, then what you specify determines how the log is written. If filename was specified without an extension, the appropriate extension is added for you.

If you open multiple log files, you may choose a different format for each file.

name(logname) specifies an optional name you may use to refer to the log while it is open. You can start multiple log files, give each a different logname, and then close, temporarily suspend, or resume them each individually. The default logname is <unnamed>.

nomsg suppresses the default message displayed at the top and bottom of the log file. This message consists of the log name (if specified in name(), otherwise unnamed), log path, log type, and date opened or closed.

Option for use with set logtype

permanently specifies that, in addition to making the change right now, the logtype setting be remembered and become the default setting when you invoke Stata.

Remarks

A full log is a file containing what you type and Stata's output that is shown in the Results window. To begin logging your session, you type log using filename. If filename contains embedded spaces, remember to enclose it in double quotation marks.

When the default log format is SMCL, log will add the extension .smcl if filename is specified without one. If text is specified or the default log type is changed to text, log adds the extension .log.

We recommend using SMCL because it preserves fonts and colors. SMCL logs can be viewed and printed from the Viewer window, as can any text file; see [R] view. Users of console Stata can use translate to produce printable versions of log files. translate also converts SMCL logs to text or other formats, such as PostScript or PDF; see [R] translate.

Examples

. log using mylog

. log close

. log using mylog, append

. log close

. log using "filename containing spaces"

. log using firstfile, name(log1) text

. log using secondfile, name(log2) smcl

. log using thirdfile, name(log3) smcl

. log query _all

. log close log1

. log close _all

Stored results

log and cmdlog store the following in r():

Macros r(name) logname r(filename) name of file r(status) on or off r(type) smcl or text

log query _all stores the following in r():

Scalars r(numlogs) number of open log files

For each open log file, log query _all also stores

Macros r(name#) logname r(filename#) name of file r(status#) on or off r(type#) smcl or text

where # varies between 1 and the value of r(numlogs). Be aware that # will not necessarily represent the order in which the log files were first opened, nor will it necessarily remain constant for a given log file upon multiple calls to log query.


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