initial description of the SAVE subcommand
[pspp-builds.git] / doc / regression.texi
index 4929d5a4cc7d77a236350c9396cc93b8a6828154..22b9f58ff664c196a574565aeac548983f452f1f 100644 (file)
@@ -44,7 +44,8 @@ REGRESSION
         /VARIABLES=var_list
         /DEPENDENT=var_list
         /STATISTICS=@{ALL, DEFAULTS, R, COEFF, ANOVA, BCOV@}
-        /EXPORT (filename)
+        /EXPORT ('file-name')
+        /SAVE
 @end display
 
 The @cmd{REGRESSION} procedure reads the active file and outputs
@@ -75,6 +76,11 @@ Analysis of variance table for the model.
 The covariance matrix for the estimated model coefficients.
 @end table
 
+The SAVE subcommand causes PSPP to save the residuals from the fitted
+model to the active file. PSPP will store the residuals in a variable
+called RES1 if no such variable exists, RES2 if RES1 already exists,
+RES3 if RES1 and RES2 already exist, etc.
+
 The EXPORT subcommand causes PSPP to write a C program containing
 functions related to the model. One such function accepts values of
 explanatory variables as arguments, and returns an estimate of the
@@ -82,7 +88,7 @@ corresponding new
 value of the dependent variable. The generated program will also contain
 functions that return prediction and confidence intervals related to
 those new estimates. PSPP will write the program to the
-'filename' given by the user, and write declarations of functions
+'file-name' given by the user, and write declarations of functions
 to a file called pspp_model_reg.h. The user can then compile the C
 program and use it as part of another program. This subcommand is a
 PSPP extension.