-------------------------------------------------------------------------------
help parmest_outdest_opts                                        (Roger Newson)
-------------------------------------------------------------------------------


Output-destination options for parmest and parmby


Syntax


    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.


Description

    These options control the destination of the output dataset (or
    resultsset) created by parmest or parmby, which may be listed and/or
    saved to disk and/or written to the memory.


Options

    list( [varlist] [if] [in] [ , [list_options ] ] ) specifies a list of
        variables in the output dataset, which will be listed to the Stata
        log by parmby or parmest.  The list() option can be used with the
        format() option (see parmest_varmod_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.
        If the rename() option is specified (see parmest_varmod_opts), then
        any variable names specified by the list() option must be the new
        names.  If the by() option is specified with parmby (see
        parmby_only_opts), then the variables specified by the list() option
        are listed by the by-variables, as when by ... : is used with 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 parmby or parmest.

    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 
        parmby or parmest.  If norestore is specified and fast is absent,
        then parmest or parmby 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 parmest or parmby will append the filename 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 estimation
        result sets saved by parmest or parmby.  These files may later be
        concatenated using append, or using dsconcat if installed.


Notes

    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.


Author

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


Also see

     Manual: [D] list, [D] save, [D] append, [P] macro
    On-line: help for list, save, append, macro
             help for parmest, parmby, parmest_ci_opts, parmest_varadd_opts,
             parmest_varmod_opts, parmby_only_opts, parmest_resultssets
             help for dsconcat if installed