help parmhet_resultsset_opts(Roger Newson)

Resultsset options for parmhet

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

idnum(#) Value of numeric dataset ID variable

nidnum(newvarname) Name of numeric dataset ID variable

idstr(string) Value of string dataset ID variable

nidstr(newvarname) Name of string dataset ID variable

sumvar(varlist) Variables to be summed in the output dataset

format(formatting_list) Display formats for variables in the output dataset

keep(varlist) Variables to be kept in the output dataset

where formatting_list is a list of form

varlist_1 format_1 ... varlist_n format_n

and 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 are used by parmhet to control the destination and content
of the output dataset (or resultsset) created.
This resultsset may be listed, saved to a file, or written to the memory,
replacing the existing input dataset.

Options

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
to produce a list of heterogeneity-test statistics,
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 parmhet.

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 parmhet.
If norestore is specified and fast is absent,
then parmhet 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 parmhet 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.

idnum(#) specifies an ID number for the output dataset.
It is used to create a numeric variable, with default name idnum, in the output dataset,
with that value for all observations.
This is useful if the output resultsset is concatenated with other resultssets
using append.

nidnum(newvarname) specifies a name for the numeric ID variable
evaluated by idnum().
If idnum() is present and nidnum() is absent,
then the name of the numeric ID variable is set to idnum.

idstr(string) specifies an ID string for the output dataset.
It is used to create a string variable, with default name idstr, in the output dataset,
with that value for all observations.
This is useful if the output resultsset is concatenated with other resultssets
using append.

nidstr(newvarname) specifies a name for the string ID variable
evaluated by idstr().
If idstr() is present and nidstr() is absent,
then the name of the string ID variable is set to idstr.

sumvar(varlist) specifies a list of variables in the input dataset
to be included in the output dataset, with values equal to their unweighted sums in the input dataset
(if by() is not specified) or to their unweighted sums within the by-group
(if by() is specified).
For instance, if the input dataset contains one observation
per study to be entered into a meta-analysis, and contains a variable N specifying the number
of subjects in the study, then the user can specify sumvar(N), and N will be present
in the output dataset, where it will contain the total number of subjects in all the studies.

format(varlist_1 format_1 ... varlist_n format_n)
specifies a list of pairs of variable lists and display formats.
The formats will be allocated to
the variables in the output dataset specified by the corresponding varlists.

keep(varlist) specifies a list of variables to be kept in the output dataset.
If keep() is not specified, then the output dataset contains all the variables
listed in the help for parmhet_resultsset.
If the variables have been renamed
using the options described in parmhet_hettest_opts,
then the user must specify the new names in the keep() option.

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, National Heart and Lung Institute, Imperial College London, UK.
Email: r.newson@imperial.ac.uk

Also see

Manual: [R] meta, [R] test

On-line: help for parmhet, parmiv,
parmhet_basic_opts,
parmhet_hettest_opts,
parmhet_resultsset

help for test

help for parmest, parmby, parmcip, metaparm, metan if installed