*! version 0.1.4 8 Nov 2022

mpitb rframe -- setup the results frame

Syntax

mpitb rframe, frame(name) [options]

* frame(name) name of results frame

replace potentially existing frame is replaced

double generate core variables of the estimate as type double

t results frame for harmonised over time levels

cot results frame for changes over time

add(name) add string as value for extra variable

ts add data and estimation time stamps

* required options.

Description

mpitb rframe prepares the result frames in which custom estimates may be
stored and is intended for advanced users and programmers who wish to store custom
quantities in separate result frames. Note that mpitb est may create result
frames as well.

Result frames contain the variables needed for storing the core estimate, including
b, se, ll, ul, pval, tval. Moreover, result
frames also contain variables holding meta information about content and context of an estimate, including
wgts, measure, indicator, k, subg, spec, loa,
ctype. Finally, result frames may have additional variables depending on their
type. There are three types of result frames:

1. Result frames for level estimates, which is the default.

2. Result frames for level estimates over time, which additionally includes an
(integer) time variable.

3. Result frames for estimates of changes over time. This frame type includes
additional variables describing starting and end point of the observation period
underlying the change estimate.

Options

frame(name) specifies the name of the frame where to store results.

replace replaces any potentially existing frame.

double generates core variables of the estimate (e.g., b, se) as type double.
The default is to generate float variables. See see data types for more details.

t prepares the results frame for harmonised over time levels. Specifically,
the (integer) time variable t is added to the results frame.

cot prepares the results frame for storing changes over time. Specifically, the variables
t0, t1, yt0, yt1 and ann are added to the results frame.

add(name) adds string as a value for the extra variable specified by the
add(name) option of mpitb rframe.

ts adds timestamp for the underlying data set and for estimation time.

Examples

Setup a simple results frame

mpitb rframe , frame(mylevs)

Setup a results frame for changes over time allowing for timestamps

mpitb rframe , frame(mycot) cot ts