"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "share/gretl_cli_cmdref.en" between
gretl-2020a.tar.xz and gretl-2020b.tar.xz

About: gretl (Gnu Regression, Econometrics and Time-series Library) is a cross-platform statistical package mainly for econometric analysis.

gretl_cli_cmdref.en  (gretl-2020a.tar.xz):gretl_cli_cmdref.en  (gretl-2020b.tar.xz)
skipping to change at line 1099 skipping to change at line 1099
Menu path: Model window, /Tests/CUSUM(SQ) Menu path: Model window, /Tests/CUSUM(SQ)
# data Dataset # data Dataset
Argument: varlist Argument: varlist
Options: --compact=method (specify compaction method) Options: --compact=method (specify compaction method)
--interpolate (do interpolation for low-frequency data) --interpolate (do interpolation for low-frequency data)
--quiet (don't report results except on error) --quiet (don't report results except on error)
--name=identifier (rename imported series) --name=identifier (rename imported series)
--odbc (import from ODBC database) --odbc (import from ODBC database)
--no-align (ODBC-specific, see below)
Reads the variables in varlist from a database file (native gretl, RATS 4.0 Reads the variables in varlist from a database file (native gretl, RATS 4.0
or PcGive), which must have been opened previously using the "open" command. or PcGive), which must have been opened previously using the "open" command.
The data command can also be used to import series from DB.NOMICS or from an The data command can also be used to import series from DB.NOMICS or from an
ODBC database; for details on those variants see gretl + DB.NOMICS or ODBC database; for details on those variants see gretl + DB.NOMICS or
chapter 39 of the Gretl User's Guide, respectively. chapter 39 of the Gretl User's Guide, respectively.
The data frequency and sample range may be established via the "setobs" and The data frequency and sample range may be established via the "setobs" and
"smpl" commands prior to using this command. Here's an example: "smpl" commands prior to using this command. Here's an example:
skipping to change at line 1156 skipping to change at line 1157
example, the following will import all series in the database whose names example, the following will import all series in the database whose names
begin with cpi: begin with cpi:
data cpi* data cpi*
The --name option can be used to set a name for the imported series other The --name option can be used to set a name for the imported series other
than the original name in the database. The parameter must be a valid gretl than the original name in the database. The parameter must be a valid gretl
identifier. This option is restricted to the case where a single series is identifier. This option is restricted to the case where a single series is
specified for importation. specified for importation.
The --no-align option applies only to importation of series via ODBC. By
default we require that the ODBC query returns information telling gretl on
which rows of the dataset to place the incoming data -- or at least that the
number of incoming values matches either the length of the dataset or the
length of the current sample range. Setting the --no-align option relaxes
this requirement: failing the conditions just mentioned, incoming values are
simply placed consecutively starting at the first row of the dataset. If
there are fewer such values than rows in the dataset the trailing rows are
filled with NAs; if there are more such values than rows the extra values
are discarded. For more on ODBC importation see chapter 39 of the Gretl
User's Guide.
Menu path: /File/Databases Menu path: /File/Databases
# dataset Dataset # dataset Dataset
Arguments: keyword parameters Arguments: keyword parameters
Option: --panel-time (see addobs below)
Examples: dataset addobs 24 Examples: dataset addobs 24
dataset addobs 2 --panel-time
dataset insobs 10 dataset insobs 10
dataset compact 1 dataset compact 1
dataset compact 4 last dataset compact 4 last
dataset expand interp dataset expand interp
dataset transpose dataset transpose
dataset sortby x1 dataset sortby x1
dataset resample 500 dataset resample 500
dataset renumber x 4 dataset renumber x 4
dataset pad-daily 7 dataset pad-daily 7
dataset clear dataset clear
Performs various operations on the data set as a whole, depending on the Performs various operations on the data set as a whole, depending on the
given keyword, which must be addobs, insobs, clear, compact, expand, given keyword, which must be addobs, insobs, clear, compact, expand,
transpose, sortby, dsortby, resample, renumber or pad-daily. Note: with the transpose, sortby, dsortby, resample, renumber or pad-daily. Note: with the
exception of clear, these actions are not available when the dataset is exception of clear, these actions are not available when the dataset is
currently subsampled by selection of cases on some Boolean criterion. currently subsampled by selection of cases on some Boolean criterion.
addobs: Must be followed by a positive integer. Adds the specified number of addobs: Must be followed by a positive integer, call it n. Adds n extra
extra observations to the end of the working dataset. This is primarily observations to the end of the working dataset. This is primarily intended
intended for forecasting purposes. The values of most variables over the for forecasting purposes. The values of most variables over the additional
additional range will be set to missing, but certain deterministic variables range will be set to missing, but certain deterministic variables are
are recognized and extended, namely, a simple linear trend and periodic recognized and extended, namely, a simple linear trend and periodic dummy
dummy variables. variables. If the dataset takes the form of a panel, the --panel-time flag
can be used to lengthen the time series for each cross-sectional unit (the
default action being to add n such units).
insobs: Must be followed by a positive integer no greater than the current insobs: Must be followed by a positive integer no greater than the current
number of observations. Inserts a single observation at the specified number of observations. Inserts a single observation at the specified
position. All subsequent data are shifted by one place and the dataset is position. All subsequent data are shifted by one place and the dataset is
extended by one observation. All variables apart from the constant are given extended by one observation. All variables apart from the constant are given
missing values at the new observation. This action is not available for missing values at the new observation. This action is not available for
panel datasets. panel datasets.
clear: No parameter required. Clears out the current data, returning gretl clear: No parameter required. Clears out the current data, returning gretl
to its initial "empty" state. to its initial "empty" state.
skipping to change at line 1921 skipping to change at line 1938
Argument: [ message ] Argument: [ message ]
Applicable only in the context of a user-defined function (see "function"). Applicable only in the context of a user-defined function (see "function").
Causes execution of the current function to terminate with an error Causes execution of the current function to terminate with an error
condition flagged. condition flagged.
The optional message argument can take the form of a string literal or the The optional message argument can take the form of a string literal or the
name of a string variable; if present it is printed as part of the error name of a string variable; if present it is printed as part of the error
message shown to the caller of the function. message shown to the caller of the function.
This command is also available in the form of a function (of the same name, See also the closely related function, "errorif".
"funcerr").
# function Programming # function Programming
Argument: fnname Argument: fnname
Opens a block of statements in which a function is defined. This block must Opens a block of statements in which a function is defined. This block must
be closed with end function. See chapter 13 of the Gretl User's Guide for be closed with end function. See chapter 13 of the Gretl User's Guide for
details. details.
# garch Estimation # garch Estimation
skipping to change at line 2187 skipping to change at line 2203
# gnuplot Graphs # gnuplot Graphs
Arguments: yvars xvar [ dumvar ] Arguments: yvars xvar [ dumvar ]
Options: --with-lines[=varspec] (use lines, not points) Options: --with-lines[=varspec] (use lines, not points)
--with-lp[=varspec] (use lines and points) --with-lp[=varspec] (use lines and points)
--with-impulses[=varspec] (use vertical lines) --with-impulses[=varspec] (use vertical lines)
--with-steps[=varspec] (use perpendicular line segments) --with-steps[=varspec] (use perpendicular line segments)
--time-series (plot against time) --time-series (plot against time)
--single-yaxis (force use of just one y-axis) --single-yaxis (force use of just one y-axis)
--ylogscale[=base] (use log scale for vertical axis)
--dummy (see below) --dummy (see below)
--fit=fitspec (see below) --fit=fitspec (see below)
--font=fontspec (see below) --font=fontspec (see below)
--band=bandspec (see below) --band=bandspec (see below)
--band-style=style (see below) --band-style=style (see below)
--matrix=name (plot columns of named matrix) --matrix=name (plot columns of named matrix)
--output=filename (send output to specified file) --output=filename (send output to specified file)
--input=filename (take input from specified file) --input=filename (take input from specified file)
Examples: gnuplot y1 y2 x Examples: gnuplot y1 y2 x
gnuplot x --time-series --with-lines gnuplot x --time-series --with-lines
skipping to change at line 2220 skipping to change at line 2237
listing of the names or numbers of the variables to be plotted with lines or listing of the names or numbers of the variables to be plotted with lines or
impulses respectively. For instance, the final example above shows how to impulses respectively. For instance, the final example above shows how to
plot y1 and y2 against x, such that y2 is represented by a line but y1 by plot y1 and y2 against x, such that y2 is represented by a line but y1 by
points. points.
If the --dummy option is selected, exactly three variables should be given: If the --dummy option is selected, exactly three variables should be given:
a single y variable, an x variable, and dvar, a discrete variable. The a single y variable, an x variable, and dvar, a discrete variable. The
effect is to plot yvar against xvar with the points shown in different effect is to plot yvar against xvar with the points shown in different
colors depending on the value of dvar at the given observation. colors depending on the value of dvar at the given observation.
You can choose the scale for the y axis to be logarithmic rather than linear
by using the --ylogscale option, together with a base parameter. For
example,
gnuplot y x --ylogscale=2
plots the data such that the vertical axis is expressed as powers of 2. If
the base is omitted, it defaults to 10.
Taking data from a matrix Taking data from a matrix
Generally, the arguments yvars and xvar are required, and refer to series in Generally, the arguments yvars and xvar are required, and refer to series in
the current dataset (given either by name or ID number). But if a named the current dataset (given either by name or ID number). But if a named
matrix is supplied via the --matrix option these arguments become optional: matrix is supplied via the --matrix option these arguments become optional:
if the specified matrix has k columns, by default the first k - 1 columns if the specified matrix has k columns, by default the first k - 1 columns
are treated as the yvars and the last column as xvar. If the --time-series are treated as the yvars and the last column as xvar. If the --time-series
option is given, however, all k columns are plotted against time. If you option is given, however, all k columns are plotted against time. If you
wish to plot selected columns of the matrix, you should specify yvars and wish to plot selected columns of the matrix, you should specify yvars and
xvar in the form of 1-based column numbers. For example if you want a xvar in the form of 1-based column numbers. For example if you want a
skipping to change at line 4286 skipping to change at line 4312
# plot Graphs # plot Graphs
Argument: [ data ] Argument: [ data ]
Options: --with-lines[=varspec] (use lines, not points) Options: --with-lines[=varspec] (use lines, not points)
--with-lp[=varspec] (use lines and points) --with-lp[=varspec] (use lines and points)
--with-impulses[=varspec] (use vertical lines) --with-impulses[=varspec] (use vertical lines)
--with-steps[=varspec] (use horizontal and vertical line segments) --with-steps[=varspec] (use horizontal and vertical line segments)
--time-series (plot against time) --time-series (plot against time)
--single-yaxis (force use of just one y-axis) --single-yaxis (force use of just one y-axis)
--ylogscale[=base] (use log scale for vertical axis)
--dummy (see below) --dummy (see below)
--fit=fitspec (see below) --fit=fitspec (see below)
--band=bandspec (see below) --band=bandspec (see below)
--band-style=style (see below) --band-style=style (see below)
--output=filename (send output to specified file) --output=filename (send output to specified file)
Examples: nile.inp Examples: nile.inp
The plot block provides an alternative to the "gnuplot" command which may be The plot block provides an alternative to the "gnuplot" command which may be
more convenient when you are producing an elaborate plot (with several more convenient when you are producing an elaborate plot (with several
options and/or gnuplot commands to be inserted into the plot file). options and/or gnuplot commands to be inserted into the plot file).
skipping to change at line 5800 skipping to change at line 5827
--no-header (see below, on CSV format) --no-header (see below, on CSV format)
--gnu-octave (use GNU Octave format) --gnu-octave (use GNU Octave format)
--gnu-R (format friendly for read.table) --gnu-R (format friendly for read.table)
--gzipped[=level] (apply gzip compression) --gzipped[=level] (apply gzip compression)
--jmulti (use JMulti ASCII format) --jmulti (use JMulti ASCII format)
--dat (use PcGive ASCII format) --dat (use PcGive ASCII format)
--decimal-comma (use comma as decimal character) --decimal-comma (use comma as decimal character)
--database (use gretl database format) --database (use gretl database format)
--overwrite (see below, on database format) --overwrite (see below, on database format)
--comment=string (see below) --comment=string (see below)
--matrix=matrix-name (see below)
Save data to filename. By default all currently defined series are saved but Save data to filename. By default all currently defined series are saved but
the optional varlist argument can be used to select a subset of series. If the optional varlist argument can be used to select a subset of series. If
the dataset is sub-sampled, only the observations in the current sample the dataset is sub-sampled, only the observations in the current sample
range are saved. range are saved.
The output file will be written in the currently set "workdir", unless the The output file will be written in the currently set "workdir", unless the
filename string contains a full path specification. filename string contains a full path specification.
The format in which the data are written may be controlled to a degree by The format in which the data are written may be controlled to a degree by
skipping to change at line 5868 skipping to change at line 5896
variable of the same name in the original dataset. variable of the same name in the original dataset.
The --comment option is available when saving data as a database or in CSV The --comment option is available when saving data as a database or in CSV
format. The required parameter is a double-quoted one-line string, attached format. The required parameter is a double-quoted one-line string, attached
to the option flag with an equals sign. The string is inserted as a comment to the option flag with an equals sign. The string is inserted as a comment
into the database index file or at the top of the CSV output. into the database index file or at the top of the CSV output.
The store command behaves in a special manner in the context of a The store command behaves in a special manner in the context of a
"progressive loop". See chapter 12 of the Gretl User's Guide for details. "progressive loop". See chapter 12 of the Gretl User's Guide for details.
Writing a matrix as a dataset
The --matrix option requires a parameter, the name of a (non-empty) matrix.
The effect of store is then, in effect, to turn the matrix into a dataset
"in the background" and write it to file as such. Matrix columns become
series; their names are taken from column-names attached to the matrix, if
any, or by default are assigned as v1, v2 and so on. If the matrix has row
names attached these are used as "observation markers" in the dataset.
Note that matrices can be written to file in their own right, see the
"mwrite" function. But in some cases it may be more useful to write them in
dataset mode.
Menu path: /File/Save data; /File/Export data Menu path: /File/Save data; /File/Export data
# summary Statistics # summary Statistics
Variants: summary [ varlist ] Variants: summary [ varlist ]
summary --matrix=matname summary --matrix=matname
Options: --simple (basic statistics only) Options: --simple (basic statistics only)
--weight=wvar (weighting variable) --weight=wvar (weighting variable)
--by=byvar (see below) --by=byvar (see below)
Examples: frontier.inp Examples: frontier.inp
 End of changes. 11 change blocks. 
8 lines changed or deleted 49 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)