{smcl} {.-} help for {cmd:listtab} {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:listtab} [ {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:vb:egin}{cmd:(}{varname}{cmd:)} {cmdab:vd:elimiter}{cmd:(}{varname}{cmd:)} {cmdab:ve:nd}{cmd:(}{varname}{cmd:)} {break} {cmdab:he:adlines}{cmd:(}{it:string_list}{cmd:)} {cmdab:fo:otlines}{cmd:(}{it:string_list}{cmd:)} {cmdab:headc:hars}{cmd:(}{it:namelist}{cmd:)} {cmdab:footc:hars}{cmd:(}{it:namelist}{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:listtab_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:listtab_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:)} {cmdab:lo:cal}{cmd:(}{help macro:{it:local_macro_name_list}}{cmd:)} ] {pstd} where {it:rowstyle} is a {help listtab##listtab_row_styles:row style} as defined below under {helpb listtab##listtab_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:listtab} 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:listtab_vars} and {cmd:listtab_rstyle} are tools for programmers to use with {cmd:listtab}. {cmd:listtab_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:listtab}. {cmd:listtab_rstyle} inputs a {cmd:listtab} {help listtab##listtab_row_styles:row style}, and saves the components of the {help listtab##listtab_row_styles:row style} in {cmd:r()} and (optionally) in local macros. {title:Options for {cmd:listtab}, {cmd:listtab_vars}, and {cmd:listtab_rstyle}} {phang} {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. {phang} {cmd:delimiter(}{it:string}{cmd:)} specifies the delimiter between values in an observation. If absent, it is set to an empty string. {phang} {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. {phang} {cmd:missnum(}{it:string}{cmd:)} specifies a string to be output for numeric missing values. If absent, it is set to an empty string. {phang} {cmd:rstyle(}{it:rowstyle}{cmd:)} specifies a {help listtab##listtab_row_styles:row style} for the table rows. A {help listtab##listtab_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 listtab##listtab_row_styles:Row styles} below. The options set by a {help listtab##listtab_row_styles:row style} may be overridden by the {cmd:begin()}, {cmd:end()}, {cmd:delimiter()} and {cmd:missnum()} options. {title:Options for {cmd:listtab} only} {phang} {cmd:vbegin(}{varname}{cmd:)} specifies a string variable to be output before any variables in the {varlist}. If {cmd:vbegin()} is absent, then the {cmd:begin()} string is output instead. {phang} {cmd:vdelimiter(}{varname}{cmd:)} specifies a string variable to be output as a delimiter between consecutive variables in the {varlist}. If {cmd:vdelimiter()} is absent, then the {cmd:delimiter()} string is output instead. {phang} {cmd:vend(}{varname}{cmd:)} specifies a string variable to be output after all variables in the {varlist}. If {cmd:vend()} is absent, then the {cmd:end()} string is output instead. {pstd} Note that the option {cmd:vbegin()} overrides {cmd:begin()}, {cmd:vdelimiter()} overrides {cmd:delimiter()}, and {cmd:vend()} overrides {cmd:end()}. The {cmd:vbegin()}, {cmd:vdelimiter()} and {cmd:vend()} options allow the user to use different begin, delimiter and end strings for different observations. {phang} {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. {phang} {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. {phang} {cmd:headchars(}{it:namelist}{cmd:)} specifies a list of {help char:variable characteristic names}, used to create table header rows containing the values of these characteristics for the variables in the {varlist}, prefixed, delimited and suffixed with the strings specified by the {cmd:begin()}, {cmd:delimiter()} and {cmd:end()} options. These header rows appear after the lines of text specified by {cmd:headlines()}, and before the first of the table rows containing the variable values. This option enables the user to add column header labels for the variables in the {varlist}. {phang} {cmd:footchars(}{it:namelist}{cmd:)} specifies a list of {help char:variable characteristic names}, used to create table footer rows containing the values of these characteristics for the variables in the {varlist}, prefixed, delimited and suffixed with the strings specified by the {cmd:begin()}, {cmd:delimiter()} and {cmd:end()} options. These header rows appear before the lines of text specified by {cmd:footlines()}, and after the last of the table rows containing the variable values. This option enables the user to add column footer labels for the variables in the {varlist}. {phang} {cmd:nolabel} specifies that numeric variables with variable labels will be output as numbers and not as labels. {phang} {cmd:type} specifies that the output from {cmd:listtab} will 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. {phang} {cmd:replace} specifies that any existing file with the same name as the {helpb using} file will be overwritten. {phang} {cmd:appendto(}{it:filename}{cmd:)} specifies the name of an existing file, to which the output from {cmd:listtab} will be appended. {phang} {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:listtab} 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:listtab} together with {helpb file} as a low-level output utility, possibly combining {cmd:listtab} output with other output. {pstd} 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:listtab_vars} only} {phang} {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:listtab_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 and suffixed by the {cmd:begin()} and {cmd:end()} strings, specified by the {help listtab##listtab_row_styles:row style}. {title:Options for {cmd:listtab_rstyle} and {cmd:listtab_vars}} {phang} {cmd:local(}{help macro:{it:local_macro_name_list}}{cmd:)} specifies the name of a {help macro:local macro} in the program that calls {cmd:listtab_vars}, or the names of up to 4 local macros in the program that calls {cmd:listtab_rstyle}. In the case of {cmd:listtab_vars}, the macro will be set to the value of the row of variable attributes generated by {cmd:listtab_vars}, specified by the {cmd:substitute()} option. In the case of {cmd:listtab_rstyle}, these macros will be set to the {cmd:begin()}, {cmd:delimiter()}, {cmd:end()} and {cmd:missnum()} options, respectively, of the row style generated by {cmd:listtab_rstyle}. The {cmd:local()} option has the advantage that the user can save multiple header rows, or multiple row style specifications, in multiple local macros. For instance, the user might want two header rows, one containing variable names, and the other containing variable labels. {marker listtab_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 simpler row styles available are as follows: {hline} {it:Row style} {cmd:begin()} {cmd:delimiter()} {cmd:end()} {cmd:missnum()} {it:Description} {cmd:html} {cmd:"
Make and Model | Weight (lbs) | Mileage (mpg) |
---|