help metaparm_outdest_opts                                       (Roger Newson)

Output-destination options for metaparm


options Description ------------------------------------------------------------------------- list(list_spec) List output dataset to Stata log and/or Results window saving(filename[,replace]) Save output dataset to a disk file norestore Write output dataset to memory fast Write output dataset to memory without precautions flist(global_macro_name) Append output filename to a global macro -------------------------------------------------------------------------

where list_spec is a specification of the form

[varlist] [if] [in] [ , [list_options ] ]

and list_options is a list of options used by the list command.


These options are available for metaparm, but only fast is available for parmcip. They control the destination of the output dataset (or resultsset) created by metaparm, which may be listed and/or saved to disk and/or written to the memory.


list( [varlist] [if] [in] [ , [list_options ] ] ) specifies a list of variables in the output dataset, which will be listed to the Stata log and/or the Results window. The list() option can be used with the format() option (see metaparm_misc_opts) to produce a list of parameter names, estimates, confidence limits, P-values and other parameter attributes, with user-specified numbers of decimal places or significant figures. The user may optionally also specify if or in clauses to list subsets of parameters, or change the display style using a list of list_options allowed as options by the list command.

saving(filename[,replace]) saves the output dataset to a disk file. If replace is specified, and a file of that name already exists, then the old file is overwritten.

norestore specifies that the output dataset will be written to the memory, overwriting any pre-existing dataset. This option is automatically set if fast is specified. Otherwise, if norestore is not specified, then the pre-existing dataset is restored in the memory after the execution of metaparm.

fast is a stronger version of norestore, intended for use by programmers. It specifies that the pre-existing dataset in the memory will not be restored, even if the user presses Break during the execution of metaparm. If norestore is specified and fast is absent, then metaparm will go to extra work so that it can restore the original data if the user presses Break.

flist(global_macro_name) specifies the name of a global macro, containing a filename list (possibly empty). If saving() is also specified, then metaparm will append the name of the dataset specified in the saving() option to the value of the global macro specified in flist(). This enables the user to build a list of filenames in a global macro, containing the output of a sequence of datasets. These files may later be concatenated using append.


Note that the user must specify at least one of the four options list(), saving(), norestore and fast. These four options specify whether the output dataset is listed to the Stata log, saved to a disk file, or written to the memory (overwriting any pre-existing dataset). More than one of these options can be specified.


Roger Newson, Imperial College London, UK. Email: r.newson@imperial.ac.uk

Also see

Manual: [D] list, [D] save, [D] append, [P] macro

Help: [D] list, [D] save, [D] append, [P] macro parmest, parmby, parmcip, metaparm, metaparm_content_opts, parmcip_opts, metaparm_resultssets