Implement DATASET commands.
[pspp-builds.git] / src / language / command.def
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2006, 2009, 2010, 2011 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 /* Utility commands acceptable anywhere. */
18 DEF_CMD (S_ANY, F_ENHANCED, "CLOSE FILE HANDLE", cmd_close_file_handle)
19 DEF_CMD (S_ANY, 0, "CACHE", cmd_cache)
20 DEF_CMD (S_ANY, 0, "CD", cmd_cd)
21 DEF_CMD (S_ANY, 0, "DATASET ACTIVATE", cmd_dataset_activate)
22 DEF_CMD (S_ANY, 0, "DATASET DECLARE", cmd_dataset_declare)
23 DEF_CMD (S_ANY, 0, "DATASET CLOSE", cmd_dataset_close)
24 DEF_CMD (S_ANY, 0, "DATASET COPY", cmd_dataset_copy)
25 DEF_CMD (S_ANY, 0, "DATASET NAME", cmd_dataset_name)
26 DEF_CMD (S_ANY, 0, "DATASET DISPLAY", cmd_dataset_display)
27 DEF_CMD (S_ANY, 0, "DO REPEAT", cmd_do_repeat)
28 DEF_CMD (S_ANY, 0, "END REPEAT", cmd_end_repeat)
29 DEF_CMD (S_ANY, 0, "ECHO", cmd_echo)
30 DEF_CMD (S_ANY, 0, "ERASE", cmd_erase)
31 DEF_CMD (S_ANY, 0, "EXIT", cmd_finish)
32 DEF_CMD (S_ANY, 0, "FILE HANDLE", cmd_file_handle)
33 DEF_CMD (S_ANY, 0, "FILE LABEL", cmd_file_label)
34 DEF_CMD (S_ANY, 0, "FINISH", cmd_finish)
35 DEF_CMD (S_ANY, 0, "HOST", cmd_host)
36 DEF_CMD (S_ANY, 0, "INCLUDE", cmd_include)
37 DEF_CMD (S_ANY, 0, "INSERT", cmd_insert)
38 DEF_CMD (S_ANY, 0, "N OF CASES", cmd_n_of_cases)
39 DEF_CMD (S_ANY, F_ABBREV, "N", cmd_n_of_cases)
40 DEF_CMD (S_ANY, 0, "NEW FILE", cmd_new_file)
41 DEF_CMD (S_ANY, 0, "PERMISSIONS", cmd_permissions)
42 DEF_CMD (S_ANY, 0, "PRESERVE", cmd_preserve)
43 DEF_CMD (S_ANY, F_ABBREV, "Q", cmd_finish)
44 DEF_CMD (S_ANY, 0, "QUIT", cmd_finish)
45 DEF_CMD (S_ANY, 0, "RESTORE", cmd_restore)
46 DEF_CMD (S_ANY, 0, "SET", cmd_set)
47 DEF_CMD (S_ANY, 0, "SHOW", cmd_show)
48 DEF_CMD (S_ANY, 0, "SUBTITLE", cmd_subtitle)
49 DEF_CMD (S_ANY, 0, "SYSFILE INFO", cmd_sysfile_info)
50 DEF_CMD (S_ANY, 0, "TITLE", cmd_title)
51
52 /* Commands that define (or replace) the active dataset. */
53 DEF_CMD (S_INITIAL | S_DATA, 0, "ADD FILES", cmd_add_files)
54 DEF_CMD (S_INITIAL | S_DATA | S_INPUT_PROGRAM | S_FILE_TYPE, 0, "DATA LIST", cmd_data_list)
55 DEF_CMD (S_INITIAL | S_DATA, 0, "GET", cmd_get)
56 DEF_CMD (S_INITIAL | S_DATA, 0, "GET DATA", cmd_get_data)
57 DEF_CMD (S_INITIAL | S_DATA, 0, "IMPORT", cmd_import)
58 DEF_CMD (S_INITIAL | S_DATA, 0, "INPUT PROGRAM", cmd_input_program)
59 DEF_CMD (S_INITIAL | S_DATA, 0, "MATCH FILES", cmd_match_files)
60 DEF_CMD (S_INITIAL | S_DATA, 0, "UPDATE", cmd_update)
61
62 /* Transformations and utilities that may appear after active
63    file definition or within INPUT PROGRAM. */
64 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "ADD VALUE LABELS", cmd_add_value_labels)
65 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "ADD DOCUMENT", cmd_add_documents)
66 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "APPLY DICTIONARY", cmd_apply_dictionary)
67 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "BREAK", cmd_break)
68 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "COMPUTE", cmd_compute)
69 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "DATAFILE ATTRIBUTE", cmd_datafile_attribute)
70 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "DISPLAY", cmd_display)
71 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "DOCUMENT", cmd_document)
72 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "DO IF", cmd_do_if)
73 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "DROP DOCUMENTS", cmd_drop_documents)
74 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "ELSE IF", cmd_else_if)
75 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "ELSE", cmd_else)
76 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "END IF", cmd_end_if)
77 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "END LOOP", cmd_end_loop)
78 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "FORMATS", cmd_formats)
79 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "IF", cmd_if)
80 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "LEAVE", cmd_leave)
81 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "LOOP", cmd_loop)
82 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "MISSING VALUES", cmd_missing_values)
83 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "MRSETS", cmd_mrsets)
84 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "NUMERIC", cmd_numeric)
85 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "PRINT EJECT", cmd_print_eject)
86 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "PRINT FORMATS", cmd_print_formats)
87 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "PRINT SPACE", cmd_print_space)
88 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "PRINT", cmd_print)
89 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "RECODE", cmd_recode)
90 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "SELECT IF", cmd_select_if)
91 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "SPLIT FILE", cmd_split_file)
92 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "STRING", cmd_string)
93 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "VALUE LABELS", cmd_value_labels)
94 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "VARIABLE ALIGNMENT", cmd_variable_alignment)
95 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "VARIABLE ATTRIBUTE", cmd_variable_attribute)
96 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "VARIABLE LABELS", cmd_variable_labels)
97 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "VARIABLE LEVEL", cmd_variable_level)
98 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "VARIABLE WIDTH", cmd_variable_width)
99 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "VECTOR", cmd_vector)
100 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "WEIGHT", cmd_weight)
101 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "WRITE FORMATS", cmd_write_formats)
102 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "WRITE", cmd_write)
103 DEF_CMD (S_DATA | S_INPUT_PROGRAM, F_ENHANCED, "XEXPORT", cmd_xexport)
104 DEF_CMD (S_DATA | S_INPUT_PROGRAM, 0, "XSAVE", cmd_xsave)
105
106 /* Commands that may appear after active dataset definition. */
107 DEF_CMD (S_DATA, 0, "AGGREGATE", cmd_aggregate)
108 DEF_CMD (S_DATA, 0, "AUTORECODE", cmd_autorecode)
109 DEF_CMD (S_DATA, 0, "BEGIN DATA", cmd_begin_data)
110 DEF_CMD (S_DATA, 0, "COUNT", cmd_count)
111 DEF_CMD (S_DATA, 0, "CROSSTABS", cmd_crosstabs)
112 DEF_CMD (S_DATA, 0, "CORRELATIONS", cmd_correlation)
113 DEF_CMD (S_DATA, 0, "DELETE VARIABLES", cmd_delete_variables)
114 DEF_CMD (S_DATA, 0, "DESCRIPTIVES", cmd_descriptives)
115 DEF_CMD (S_DATA, 0, "EXAMINE", cmd_examine)
116 DEF_CMD (S_DATA, 0, "EXECUTE", cmd_execute)
117 DEF_CMD (S_DATA, 0, "EXPORT", cmd_export)
118 DEF_CMD (S_DATA, 0, "FACTOR", cmd_factor)
119 DEF_CMD (S_DATA, 0, "FILTER", cmd_filter)
120 DEF_CMD (S_DATA, 0, "FLIP", cmd_flip)
121 DEF_CMD (S_DATA, 0, "FREQUENCIES", cmd_frequencies)
122 DEF_CMD (S_DATA, 0, "LIST", cmd_list)
123 DEF_CMD (S_DATA, 0, "MODIFY VARS", cmd_modify_vars)
124 DEF_CMD (S_DATA, 0, "NPAR TESTS", cmd_npar_tests)
125 DEF_CMD (S_DATA, 0, "ONEWAY", cmd_oneway)
126 DEF_CMD (S_DATA, 0, "PEARSON CORRELATIONS", cmd_correlation)
127 DEF_CMD (S_DATA, 0, "QUICK CLUSTER", cmd_quick_cluster)
128 DEF_CMD (S_DATA, 0, "RANK", cmd_rank)
129 DEF_CMD (S_DATA, 0, "REGRESSION", cmd_regression)
130 DEF_CMD (S_DATA, 0, "RELIABILITY", cmd_reliability)
131 DEF_CMD (S_DATA, 0, "RENAME VARIABLES", cmd_rename_variables)
132 DEF_CMD (S_DATA, 0, "ROC", cmd_roc)
133 DEF_CMD (S_DATA, 0, "SAMPLE", cmd_sample)
134 DEF_CMD (S_DATA, 0, "SAVE", cmd_save)
135 DEF_CMD (S_DATA, 0, "SAVE TRANSLATE", cmd_save_translate)
136 DEF_CMD (S_DATA, 0, "SORT CASES", cmd_sort_cases)
137 DEF_CMD (S_DATA, 0, "T-TEST", cmd_t_test)
138 DEF_CMD (S_DATA, 0, "TEMPORARY", cmd_temporary)
139 DEF_CMD (S_DATA, 0, "USE", cmd_use)
140
141 /* Commands valid only with INPUT PROGRAM. */
142 DEF_CMD (S_INPUT_PROGRAM, 0, "END CASE", cmd_end_case)
143 DEF_CMD (S_INPUT_PROGRAM, 0, "END FILE", cmd_end_file)
144 DEF_CMD (S_INPUT_PROGRAM, 0, "END INPUT PROGRAM", cmd_end_input_program)
145 DEF_CMD (S_INPUT_PROGRAM, 0, "REREAD", cmd_reread)
146
147 /* Commands for testing PSPP. */
148 DEF_CMD (S_ANY, F_TESTING, "DEBUG EVALUATE", cmd_debug_evaluate)
149 DEF_CMD (S_ANY, F_TESTING, "DEBUG FORMAT GUESSER", cmd_debug_format_guesser)
150 DEF_CMD (S_ANY, F_TESTING, "DEBUG MOMENTS", cmd_debug_moments)
151 DEF_CMD (S_ANY, F_TESTING, "DEBUG PAPER SIZE", cmd_debug_paper_size)
152 DEF_CMD (S_ANY, F_TESTING, "DEBUG POOL", cmd_debug_pool)
153 DEF_CMD (S_ANY, F_TESTING, "DEBUG FLOAT FORMAT", cmd_debug_float_format)
154 DEF_CMD (S_ANY, F_TESTING, "DEBUG XFORM FAIL", cmd_debug_xform_fail)
155
156 /* Unimplemented commands. */
157 UNIMPL_CMD ("2SLS", "Two stage least squares regression")
158 UNIMPL_CMD ("ACF", "Autocorrelation function")
159 UNIMPL_CMD ("ALSCAL", "Multidimensional scaling")
160 UNIMPL_CMD ("ANACOR", "Correspondence analysis")
161 UNIMPL_CMD ("ANOVA", "Factorial analysis of variance")
162 UNIMPL_CMD ("CASEPLOT", "Plot time series")
163 UNIMPL_CMD ("CASESTOVARS", "Restructure complex data")
164 UNIMPL_CMD ("CATPCA", "Categorical principle components analysis")
165 UNIMPL_CMD ("CATREG", "Categorical regression")
166 UNIMPL_CMD ("CCF", "Time series cross correlation")
167 UNIMPL_CMD ("CLEAR TRANSFORMATIONS", "Clears transformations from active dataset")
168 UNIMPL_CMD ("CLUSTER", "Hierachial clustering")
169 UNIMPL_CMD ("CONJOINT", "Analyse full concept data")
170 UNIMPL_CMD ("CORRESPONDENCE", "Show correspondence")
171 UNIMPL_CMD ("COXREG", "Cox proportional hazards regression")
172 UNIMPL_CMD ("CREATE", "Create time series data")
173 UNIMPL_CMD ("CSDESCRIPTIVES", "Complex samples descriptives")
174 UNIMPL_CMD ("CSGLM", "Complex samples GLM")
175 UNIMPL_CMD ("CSLOGISTIC", "Complex samples logistic regression")
176 UNIMPL_CMD ("CSPLAN", "Complex samples design")
177 UNIMPL_CMD ("CSSELECT", "Select complex samples")
178 UNIMPL_CMD ("CSTABULATE", "Tabulate complex samples")
179 UNIMPL_CMD ("CTABLES", "Display complex samples")
180 UNIMPL_CMD ("CURVEFIT", "Fit curve to line plot")
181 UNIMPL_CMD ("DATE", "Create time series data")
182 UNIMPL_CMD ("DEFINE", "Syntax macros")
183 UNIMPL_CMD ("DETECTANOMALY", "Find unusual cases")
184 UNIMPL_CMD ("DISCRIMINANT", "Linear discriminant analysis")
185 UNIMPL_CMD ("EDIT", "obsolete")
186 UNIMPL_CMD ("END FILE TYPE", "Ends complex data input")
187 UNIMPL_CMD ("FILE TYPE", "Complex data input")
188 UNIMPL_CMD ("FIT", "Goodness of Fit")
189 UNIMPL_CMD ("GENLOG", "Categorical model fitting")
190 UNIMPL_CMD ("GET TRANSLATE", "Read other file formats")
191 UNIMPL_CMD ("GGRAPH", "Custom defined graphs")
192 UNIMPL_CMD ("GLM", "General Linear Model")
193 UNIMPL_CMD ("GRAPH", "Draw graphs")
194 UNIMPL_CMD ("HILOGLINEAR", "Hierarchial loglinear models")
195 UNIMPL_CMD ("HOMALS", "Homogeneity analysis")
196 UNIMPL_CMD ("IGRAPH", "Interactive graphs")
197 UNIMPL_CMD ("INFO", "Local Documentation")
198 UNIMPL_CMD ("KEYED DATA LIST", "Read nonsequential data")
199 UNIMPL_CMD ("KM", "Kaplan-Meier")
200 UNIMPL_CMD ("LOGISTIC REGRESSION", "Regression Analysis")
201 UNIMPL_CMD ("LOGLINEAR", "General model fitting")
202 UNIMPL_CMD ("MANOVA", "Multivariate analysis of variance")
203 UNIMPL_CMD ("MAPS", "Geographical display")
204 UNIMPL_CMD ("MATRIX", "Matrix processing")
205 UNIMPL_CMD ("MATRIX DATA", "Matrix data input")
206 UNIMPL_CMD ("MCONVERT", "Convert covariance/correlation matrices")
207 UNIMPL_CMD ("MEANS", cmd_means)
208 UNIMPL_CMD ("MIXED", "Mixed linear models")
209 UNIMPL_CMD ("MODEL CLOSE", "Close server connection")
210 UNIMPL_CMD ("MODEL HANDLE", "Define server connection")
211 UNIMPL_CMD ("MODEL LIST", "Show existing models")
212 UNIMPL_CMD ("MODEL NAME", "Specify model label")
213 UNIMPL_CMD ("MULTIPLE CORRESPONDENCE", "Multiple correspondence analysis")
214 UNIMPL_CMD ("MULT RESPONSE", "Multiple reponse analysis")
215 UNIMPL_CMD ("MVA", "Missing value analysis")
216 UNIMPL_CMD ("NAIVEBAYES", "Small sample bayesian prediction")
217 UNIMPL_CMD ("NLR", "Non Linear Regression")
218 UNIMPL_CMD ("NOMREG", "Multinomial logistic regression")
219 UNIMPL_CMD ("NONPAR CORR", "Nonparametric correlation")
220 UNIMPL_CMD ("NUMBERED", "")
221 UNIMPL_CMD ("OLAP CUBES", "On-line analytical processing")
222 UNIMPL_CMD ("OMS", "Output management")
223 UNIMPL_CMD ("ORTHOPLAN", "Orthogonal effects design")
224 UNIMPL_CMD ("OVERALS", "Nonlinear canonical correlation")
225 UNIMPL_CMD ("PACF", "Partial autocorrelation")
226 UNIMPL_CMD ("PARTIAL CORR", "Partial correlation")
227 UNIMPL_CMD ("PLANCARDS", "Conjoint analysis planning")
228 UNIMPL_CMD ("PLUM", "Estimate ordinal regression models")
229 UNIMPL_CMD ("POINT", "Marker in keyed file")
230 UNIMPL_CMD ("PPLOT", "Plot time series variables")
231 UNIMPL_CMD ("PREDICT", "Specify forecast period")
232 UNIMPL_CMD ("PREFSCAL", "Multidimensional unfolding")
233 UNIMPL_CMD ("PRINCALS", "PCA by alternating least squares")
234 UNIMPL_CMD ("PROBIT", "Probit analysis")
235 UNIMPL_CMD ("PROCEDURE OUTPUT", "Specify output file")
236 UNIMPL_CMD ("PROXIMITIES", "Pairwise similarity")
237 UNIMPL_CMD ("PROXSCAL", "Multidimensional scaling of proximity data")
238 UNIMPL_CMD ("RATIO STATISTICS", "Descriptives of ratios")
239 UNIMPL_CMD ("READ MODEL", "Read new model")
240 UNIMPL_CMD ("RECORD TYPE", "Defines a type of record within FILE TYPE")
241 UNIMPL_CMD ("REFORMAT", "Read obsolete files")
242 UNIMPL_CMD ("REPEATING DATA", "Specify multiple cases per input record")
243 UNIMPL_CMD ("REPORT", "Pretty print working file")
244 UNIMPL_CMD ("RMV", "Replace missing values")
245 UNIMPL_CMD ("SCRIPT", "Run script file")
246 UNIMPL_CMD ("SEASON", "Estimate seasonal factors")
247 UNIMPL_CMD ("SELECTPRED", "Select predictor variables")
248 UNIMPL_CMD ("SPCHART", "Plot control charts")
249 UNIMPL_CMD ("SPECTRA", "Plot spectral density")
250 UNIMPL_CMD ("SUMMARIZE", "Univariate statistics")
251 UNIMPL_CMD ("SURVIVAL", "Survival analysis")
252 UNIMPL_CMD ("TDISPLAY", "Display active models")
253 UNIMPL_CMD ("TREE", "Create classification tree")
254 UNIMPL_CMD ("TSAPPLY", "Apply time series model")
255 UNIMPL_CMD ("TSET", "Set time sequence variables")
256 UNIMPL_CMD ("TSHOW", "Show time sequence variables")
257 UNIMPL_CMD ("TSMODEL", "Estimate time series model")
258 UNIMPL_CMD ("TSPLOT", "Plot time sequence variables")
259 UNIMPL_CMD ("TWOSTEP CLUSTER", "Cluster observations")
260 UNIMPL_CMD ("UNIANOVA", "Univariate analysis")
261 UNIMPL_CMD ("UNNUMBERED", "obsolete")
262 UNIMPL_CMD ("VALIDATEDATA", "Identify suspicious cases")
263 UNIMPL_CMD ("VARCOMP", "Estimate variance")
264 UNIMPL_CMD ("VARSTOCASES", "Restructure complex data")
265 UNIMPL_CMD ("VERIFY", "Report time series")
266 UNIMPL_CMD ("WLS", "Weighted least squares regression")
267 UNIMPL_CMD ("XGRAPH", "High resolution charts")