{smcl} {.-} help for {cmd:listtex} {right:(Roger Newson)} {.-} {title:List a variable list to a file or to the log for inclusion in a TeX, HTML or word processor table} {p 8 21 2} {cmd:listtex} [ {varlist} ] [ {helpb using} {it:filename} ] {ifin} [ , {break} {cmdab:b:egin}{cmd:(}{it:string}{cmd:)} {cmdab:d:elimiter}{cmd:(}{it:string}{cmd:)} {cmdab:e:nd}{cmd:(}{it:string}{cmd:)} {cmdab:m:issnum}{cmd:(}{it:string}{cmd:)} {cmdab:rs:tyle}{cmd:(}{it:rowstyle}{cmd:)} {break} {cmdab:he:adlines}{cmd:(}{it:string_list}{cmd:)} {cmdab:fo:otlines}{cmd:(}{it:string_list}{cmd:)} {cmdab:nol:abel} {cmdab:t:ype} {cmdab:replace:} {cmdab:ap:pendto}{cmd:(}{it:filename}{cmd:)} {cmdab:ha:ndle}{cmd:(}{it:handle_name}{cmd:)} ] {p 8 21 2} {cmd:listtex_vars} [ {varlist} ] [ , {break} {cmdab:b:egin}{cmd:(}{it:string}{cmd:)} {cmdab:d:elimiter}{cmd:(}{it:string}{cmd:)} {cmdab:e:nd}{cmd:(}{it:string}{cmd:)} {cmdab:m:issnum}{cmd:(}{it:string}{cmd:)} {cmdab:rs:tyle}{cmd:(}{it:rowstyle}{cmd:)} {break} {cmdab:su:bstitute}{cmd:(}{it:variable_attribute}{cmd:)} {cmdab:lo:cal}{cmd:(}{help macro:{it:local_macro_name}}{cmd:)} ] {p 8 21 2} {cmd:listtex_rstyle} [ , {cmdab:b:egin}{cmd:(}{it:string}{cmd:)} {cmdab:d:elimiter}{cmd:(}{it:string}{cmd:)} {cmdab:e:nd}{cmd:(}{it:string}{cmd:)} {cmdab:m:issnum}{cmd:(}{it:string}{cmd:)} {cmdab:rs:tyle}{cmd:(}{it:rowstyle}{cmd:)} ] {pstd} where {it:rowstyle} is a {help listtex##listtex_row_styles:row style} as defined below under {helpb listtex##listtex_row_styles:Row Styles}, {break} {it:variable_attribute} is {pstd} {cmd:name} | {cmd:type} | {cmd:format} | {cmd:vallab} | {cmd:varlab} | {cmd:char} {help char:{it:charname}} {pstd} and {help char:{it:charname}} is a {help char:characteristic name}. {title:Description} {pstd} {cmd:listtex} lists the variables in the {varlist} (or all variables, if the {varlist} is absent) to the Stata log, or to a file (or files) specified by {helpb using}, {cmd:appendto()} or {cmd:handle()}, in a table format, with one table row per observation and the values of different variables separated by a delimiter string. Optionally, the user may specify a list of header lines before the data rows and/or a list of footer lines after the data rows. The log or output file can then be cut and pasted, or linked or embedded (eg with the TeX {cmd:\input} command), into a TeX, HTML or word processor table. Values of numeric variables are output according to their display formats or value labels (if non-missing), or as the missing value string specified by {cmd:missnum()} (if missing). {pstd} The commands {cmd:listtex_vars} and {cmd:listtex_rstyle} are tools for programmers to use with {cmd:listtex}. {cmd:listtex_vars} generates a table row, containing, in each column, an attribute (such as the name) of the variable corresponding to the column. This generated table row is saved in {cmd:r(vars)} and (optionally) in a local macro, and is then typically used to specify a {cmd:headlines()} option for {cmd:listtex}. {cmd:listtex_rstyle} inputs a {cmd:listtex} {help listtex##listtex_row_styles:row style}, and saves in {cmd:r()} the components of the {help listtex##listtex_row_styles:row style}. {pstd} Users of {help version:Stata Versions 11 or higher} should probably not use {cmd:listtex}. Instead, they should probably use the {helpb listtab} package, which can be downloaded from {help ssc:SSC}, and was introduced as the {help version:Stata Version 11} replacement for {cmd:listtex}. {title:Options for {cmd:listtex}, {cmd:listtex_vars}, and {cmd:listtex_rstyle}} {p 4 8 2}{cmd:begin(}{it:string}{cmd:)} specifies a string to be output at the beginning of every output line corresponding to an observation. If absent, it is set to an empty string. {p 4 8 2}{cmd:delimiter(}{it:string}{cmd:)} specifies the delimiter between values in an observation. If absent, it is set to "&". {p 4 8 2}{cmd:end(}{it:string}{cmd:)} specifies a string to be output at the end of every output line corresponding to an observation. If absent, it is set to an empty string. {p 4 8 2}{cmd:missnum(}{it:string}{cmd:)} specifies a string to be output for numeric missing values. If absent, it is set to an empty string. {p 4 8 2}{cmd:rstyle(}{it:rowstyle}{cmd:)} specifies a {help listtex##listtex_row_styles:row style} for the table rows. A {help listtex##listtex_row_styles:row style} is a named combination of values for the {cmd:begin()}, {cmd:end()}, {cmd:delimiter()} and {cmd:missnum()} options. It may be {cmd:html}, {cmd:htmlhead}, {cmd:tabular}, {cmd:halign}, {cmd:settabs} or {cmd:tabdelim}. Row styles are specified under {helpb listtex##listtex_row_styles:Row styles} below. The options set by a {help listtex##listtex_row_styles:row style} may be overridden by the {cmd:begin()}, {cmd:end()}, {cmd:delimiter()} and {cmd:missnum()} options. {title:Options for {cmd:listtex} only} {p 4 8 2}{cmd:headlines(}{it:string_list}{cmd:)} specifies a list of lines of text to appear before the first of the table rows in the output. This option enables the user to add table preludes and/or headers. {p 4 8 2}{cmd:footlines(}{it:string_list}{cmd:)} specifies a list of lines of text to appear after the last of the table rows in the output. This option enables the user to add table postludes and/or footnotes. {p 4 8 2}{cmd:nolabel} specifies that numeric variables with variable labels are to be output as numbers and not as labels. {p 4 8 2}{cmd:type} specifies that the output from {cmd:listtex} must be typed to the Stata log (or to the Results window). The data can then be cut and pasted from the Stata log (or from the Results window) to a TeX, HTML or word processor file. {p 4 8 2}{cmd:replace} specifies that any existing file with the same name as the {helpb using} file must be overwritten. {p 4 8 2}{cmd:appendto(}{it:filename}{cmd:)} specifies the name of a file, to which the output from {cmd:listtex} will be appended. {p 4 8 2}{cmd:handle(}{it:handle_name}{cmd:)} specifies the name of a file handle, specifying a file that is already open for output as a text file, to which the output from {cmd:listtex} will be added, without closing the file. See help for {helpb file} for details about file handles. This option allows the user to use {cmd:listtex} together with {helpb file} as a low-level output utility, possibly combining {cmd:listtex} output with other output. {p 4 8 2}Note that the user must specify the {helpb using} qualifier and/or the {cmd:type} option and/or the {cmd:appendto()} option and/or the {cmd:handle()} option. {title:Options for {cmd:listtex_vars} only} {p 4 8 2}{cmd:substitute(}{it:variable_attribute}{cmd:)} specifies a variable attribute to be entered into the columns of the generated table row. This attribute may be {cmd:name}, {cmd:type}, {cmd:format}, {cmd:vallab}, {cmd:varlab}, or {cmd:char} {help char:{it:charname}}, specifying the {help varname:variable name}, {help data types:storage type}, {help format:display format}, {help label:value label}, {help label:variable label}, or a named {help char:variable characteristic}, respectively. If {cmd:substitute()} is not specified, then {cmd:substitute(name)} is assumed, and variable names are entered in the columns of the generated table row. In the table row generated by {cmd:listtex_vars}, the attributes of the variables in the {varlist} (or of all the variables, if the {varlist} is absent) appear in the columns, and are separated by the {cmd:delimiter()} string, and prefixed by the {cmd:begin()} and {cmd:end()} strings, specified by the {help listtex##listtex_row_styles:row style}. {p 4 8 2}{cmd:local(}{help macro:{it:local_macro_name}}{cmd:)} specifies the name of a {help macro:local macro} in the program that calls {cmd:listtex_vars}. This macro will be assigned the value of the row of variable attributes generated by {cmd:listtex_vars}. Whether or not {cmd:local()} is specified, {cmd:listtex_vars} saves the generated table row in {cmd:r(vars)}. The {cmd:local()} option has the advantage that the user can save multiple header rows in multiple local macros. For instance, the user might want two header rows, one containing variable names, and the other containing variable labels. {marker listtex_row_styles}{...} {title:Row styles} {pstd} A row style is a combination of the {cmd:begin()}, {cmd:end()}, {cmd:delimiter()} and {cmd:missnum()} options. Each row style produces rows for a particular type of table (HTML, TeX or word processor). The row styles available are as follows: {hline} {cmd:Row style} {cmd:begin} {cmd:delimiter} {cmd:end} {cmd:missnum} {cmd:Description} {cmd:html} "
Make and Model | Weight (lbs) | Mileage (mpg) |
---|