📄 brrstat.hlp
字号:
{smcl}
{* 18mar2005}{...}
{cmd:help brrstat}{...}
{right:also see: {help undocumented}}
{hline}
{title:Title}
{pstd}
{hi:brrstat} {hline 2}
Reporting results from balanced repeated replication (BRR)
{title:Syntax}
{pin}
{cmd:brrstat}
[{varlist}]
{ifin}
[{cmd:,} {it:options} ]
{pin}
{cmd:brrstat}
[{it:namelist}]
[{opt using} {it:filename}]
{ifin}
[{cmd:,} {it:options} ]
{p2colset 9 24 28 2}{...}
{p2col :{it:options}}description{p_end}
{p2line}
{p2col :{opt notable}}suppress table of output{p_end}
{p2col :{opt noh:eader}}suppress the table header{p_end}
{p2col :{opt nol:egend}}suppress the table legend{p_end}
{p2col :{opt v:erbose}}display the full table legend{p_end}
{p2col :{opt l:evel(#)}}confidence level for CIs{p_end}
{p2col :{opt ti:tle(text)}}title for BRR results{p_end}
{p2col :{opt s:tat(vector)}}observed values{p_end}
{p2col :{opt n(#)}}sample size{p_end}
{p2col :{opt mse}}use MSE formula for variance estimate{p_end}
{p2line}
{pstd}
{cmd:brrstat} shares the features of all estimation commands, except that
{cmd:mfx}, {cmd:adjust}, {cmd:predict}, and {cmd:predictnl} are not allowed;
see {help estcom}.
{title:Description}
{pstd}
{cmd:brrstat} is a programmer's command that computes and displays estimation
results from BRR statistics.
{pstd}
{cmd:brrstat} computes a variance covariance matrix using the variables in
{it:varlist}, assuming the variables contain replicate values from a BRR
procedure.
{pstd}
If given the {opt using} modifier, {cmd:brrstat} will use the data in
{it:filename} to perform its calculations while preserving the data
currently in memory. The data in memory is used by default.
{pstd}
The following options may be used to replay estimation results from
{cmd:brrstat}:
{pmore}
{opt l:evel(#)}
{opt notable}
{opt noh:eader}
{opt nol:egend}
{opt v:erbose}
{opt ti:tle(text)}
{pstd}
For all other options (including {opt using}, {it:if}, and {it:in})
{cmd:brrstat} requires a dataset.
{title:Options}
{phang}
{opt notable} prevents displaying the output table.
{phang}
{opt noheader} suppresses the displaying of the table header. This option
implies {opt nolegend}.
{phang}
{opt nolegend} suppresses the displaying of the table legend. The table
legend identifies the rows of the table with the expressions they represent.
{phang}
{opt verbose} requests that the full table legend be displayed. By default,
coefficients and standard errors are not displayed.
{phang}
{opt level(#)}; see {help estimation_options}.
{phang}
{opt title(text)} specifies a title to be displayed above the
table of BRR results; the default title is "BRR statistics".
{phang}
{opt stat(vector)} allows the user to specify the observed value of each
statistic (i.e., the value of the statistic using the original dataset).
{title:Remarks}
{pstd}
Although {cmd:brrstat} allows users to specify the observed value of each
replicate statistic via the {cmd:stat()} option, programmers may be interested
in what {cmd:brrstat} uses when this option is not supplied.
{pstd}
When working from a BRR dataset, {cmd:brrstat} first checks the
data characteristics (see {help char}). Here is a list of the
characteristics that {cmd:brrstat} understands:
{phang}
{cmd:_dta[brr_version]} identifies the version of the BRR dataset. This
characteristic is assumed to be empty (not defined) or {cmd:1}; otherwise
{cmd:brrstat} will behave as if it were empty. This version informs
{cmd:brrstat} which other characteristics to look for in the BRR dataset.
{pmore}
{cmd:brrstat} uses the following characteristics from version {cmd:1}
BRR datasets:
{pmore2}
{cmd:_dta[N]}{break}
{cmd:_dta[N_strata]}{break}
{cmd:_dta[N_psu]}{break}
{cmd:_dta[N_pop]}{break}
{cmd:_dta[strata]}{break}
{cmd:_dta[psu]}
{cmd:_dta[wtype]}
{cmd:_dta[wexp]}
{cmd:_dta[rweights]}
{cmd:_dta[command]}{break}
{cmd:_dta[names]}{break}
{it:varname}{cmd:[observed]}{break}
{it:varname}{cmd:[expression]}
{pmore}
An empty BRR dataset version implies that the dataset was not created by
the {cmd:brr}. In this case, the {opt stat()} option is required. All
other characteristics are ignored.
{phang}
{cmd:_dta[N_strata]} is the number of strata in the observed dataset.
{phang}
{cmd:_dta[N_psu]} is the number of PSUs in the observed dataset.
{phang}
{cmd:_dta[strata]} is the name of the variable that originally identified the
strata.
{phang}
{cmd:_dta[psu]} is the name of the variable from the original dataset that
identifies the primary sampling units.
{phang}
{cmd:_dta[wtype]},
{cmd:_dta[wexp]}, and
{cmd:_dta[rweights]} identify the weight type, expression, and list of
replicate weight variable names from the observed dataset.
{phang}
{cmd:_dta[command]} is the command used to compute the observed values
of the statistics.
{phang}
{cmd:_dta[names]} identifies the variables containing the jackknife replicates.
{phang}
{it:varname}{cmd:[observed]} is the observed value of the statistic
identified by {it:varname}. This characteristic may be overruled by
specifying the {cmd:stat()} option.
{phang}
{it:varname}{cmd:[expression]} is the expression or label that
describes the statistic identified by {it:varname}.
{title:Results}
{pstd}
{cmd:brrstat} saves in {cmd:e()}:
{p2colset 9 24 28 2}{...}
{pstd}
Scalars
{p2col :{cmd:e(N)}}sample size{p_end}
{p2col :{cmd:e(N_strata)}}number of strata{p_end}
{p2col :{cmd:e(N_psu)}}number of PSUs{p_end}
{p2col :{cmd:e(N_reps)}}number of requested replications{p_end}
{pstd}
Macros
{p2col :{cmd:e(cmd)}}{cmd:brr}{p_end}
{p2col :{cmd:e(command)}}{it:command} from {hi:_dta[command]}{p_end}
{p2col :{cmd:e(exp}{it:#}{cmd:)}}expression for the {it:#}th statistic{p_end}
{p2col :{cmd:e(strata)}}strata variable{p_end}
{p2col :{cmd:e(cluster)}}cluster variable{p_end}
{p2col :{cmd:e(missing)}}"{hi:missing}"
if missing values found, otherwise empty{p_end}
{p2col :{cmd:e(vcetype)}}"{hi:BRR}" or "{hi:BRR *}"{p_end}
{p2col :{cmd:e(vce)}}"{hi:brr}"{p_end}
{p2col :{cmd:e(mse)}}"{hi:mse}" if {opt mse} option supplied{p_end}
{pstd}
Matrices
{p2col :{cmd:e(b)}}observed statistics{p_end}
{p2col :{cmd:e(V)}}BRR variance matrix{p_end}
{p2col :{cmd:e(brr_b)}}replicate means{p_end}
{p2colreset}{...}
{title:Also see}
{psee}
Online: help for
{help "svy: brr"};
{help char}
{p_end}
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -