📄 codebook.hlp
字号:
{smcl}
{* 20jan2005}{...}
{cmd:help codebook}{right:dialog: {bf:{dialog codebook}}}
{hline}
{title:Title}
{p2colset 5 21 23 2}{...}
{p2col :{hi:[D] codebook} {hline 2}}Produce a codebook describing the
contents of data{p_end}
{p2colreset}{...}
{title:Syntax}
{p 8 17 2}
{cmd:codebook}
[{varlist}]
{ifin}
[{cmd:,} {it:options}]
{synoptset 23 tabbed}{...}
{synopthdr}
{synoptline}
{syntab :Options}
{synopt :{opt a:ll}}print complete report without missing values{p_end}
{synopt :{opt h:eader}}print dataset name and last saved date{p_end}
{synopt :{opt n:otes}}print any notes attached to variables{p_end}
{synopt :{opt m:v}}report pattern of missing values{p_end}
{synopt :{opt t:abulate(#)}}set tables/summary statistics threshold; default
is {cmd:tabulate(9)}{p_end}
{synopt :{opt p:roblems}}report potential problems in dataset{p_end}
{synopt :{opt d:etail}}display detailed report on the variables; only with
{opt problems}{p_end}
{syntab :Languages}
{synopt :{opt lang:uages}[{cmd:(}{it:namelist}{cmd:)}]}use with multilingual
datasets; see {helpb label language} for details{p_end}
{synoptline}
{p2colreset}{...}
{title:Description}
{pstd}
{opt codebook} examines the variable names, labels, and data to produce a
codebook describing the dataset.
{title:Options}
{dlgtab:Options}
{phang}
{opt all}
is equivalent to specifying the {opt header} and {opt notes} options. It
provides a complete report, which excludes only performing {opt mv}.
{phang}
{opt header}
adds a header to the top of the output, which lists the dataset name,
the date that the dataset was last saved, etc.
{phang}
{opt notes}
lists any notes attached to the variables; see {helpb notes}.
{phang}
{opt mv}
specifies that {opt codebook} search the data to determine the pattern of
missing values. This is a cpu-intensive task.
{phang}
{opt tabulate(#)}
specifies the number of unique values of the variables to use to determine
whether a variable is categorical or continuous. Missing values are not
included in this count. The default is 9; when there are more than 9 unique
values, the variable is classified as continuous. Extended missing values
will be included in the tabulation.
{phang}
{opt problems}
specifies that a summary report is produced describing potential problems
that have been diagnosed:
{phang2}- variables are labeled with an undefined value label{p_end}
{phang2}- incompletely value-labeled variables{p_end}
{phang2}- variables that are constant, including always missing{p_end}
{phang2}- trailing, trimming, and embedded spaces in string variables{p_end}
{phang2}- noninteger-valued date variables{p_end}
{pmore}
See {help codebook problems} for a discussion of these problems and advice on
overcoming them.
{phang}
{opt detail}
may only be specified with the {opt problems} option.
It specifies that the detailed report on the variables not be suppressed.
{dlgtab:Languages}
{phang}
{cmd:languages}[{cmd:(}{it:namelist}{cmd:)}]
is for use with multilingual datasets; see {helpb label language}. It
indicates that the codebook pertains to the languages in {it:namelist}
or to all defined languages if no such list is specified as an argument to
{opt languages()}. The output of {opt codebook} lists the data label and
variable labels in these languages and which value labels are attached to
variables in these languages.
{pmore}
Problems are diagnosed in all these languages, as well. The problem report
does not provide details in which language problems occur. We advise you to
rerun {opt codebook} for problematic variables; specify {opt detail} to
produce the problem report again.
{pmore}
If you have a multilingual dataset but do not specify {opt languages()},
all output, including the problem report, is shown in the "active" language.
{title:Examples}
{pstd}With standard (monolingual) datasets{p_end}
{phang2}{cmd:. codebook}{p_end}
{phang2}{cmd:. codebook, mv}{p_end}
{phang2}{cmd:. codebook, header notes}{p_end}
{phang2}{cmd:. codebook, mv notes}{p_end}
{phang2}{cmd:. codebook make mpg rep78*}{p_end}
{phang2}{cmd:. codebook make mpg rep78*, header notes mv}{p_end}
{phang2}{cmd:. codebook inc*m inc*f, problems}{p_end}
{phang2}{cmd:. codebook _all, problems detail}{p_end}
{pstd}
With multilingual datasets, with languages {opt en}, {opt de},
and {opt es}, and with active language {opt de}{p_end}
{space 8}{cmd:. codebook item*}{right:codebook only for {opt de} }
{space 8}{cmd:. codebook _all, problem lang}{right:codebook for all languages }
{space 8}{cmd:. codebook, prob det lang(en es)}{...}
{right:codebook for {opt en} and {opt es} }
{title:Also see}
{psee}
Manual: {bf:[D] codebook}
{psee}
Online: {help codebook problems},
{helpb describe},
{helpb inspect},
{helpb labelbook},
{helpb notes},
{helpb split}
{p_end}
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -