From a59f08035a1775d115fb808ac64f0326767da919 Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Tue, 2 Sep 2025 15:37:42 -0700 Subject: [PATCH] rust: Move all command documentation into a single directory. This makes it much easier to find the documentation for a command, or to reference a command's documentation, because it's not necessary to guess which chapter it is documented in. --- rust/doc/src/SUMMARY.md | 252 +++++++++--------- .../commands/{utilities => }/add-document.md | 0 .../src/commands/{combining => }/add-files.md | 2 +- .../{variables => }/add-value-labels.md | 0 rust/doc/src/commands/{data => }/aggregate.md | 18 +- .../{spss-io => }/apply-dictionary.md | 23 +- .../doc/src/commands/{data => }/autorecode.md | 0 .../src/commands/{data-io => }/begin-data.md | 0 rust/doc/src/commands/{control => }/break.md | 0 .../doc/src/commands/{utilities => }/cache.md | 0 rust/doc/src/commands/{utilities => }/cd.md | 0 .../{data-io => }/close-file-handle.md | 2 +- .../{combining/index.md => combining.md} | 22 +- .../src/commands/{utilities => }/comment.md | 0 rust/doc/src/commands/{data => }/compute.md | 28 +- .../commands/{control/index.md => control.md} | 2 + .../commands/{statistics => }/correlations.md | 0 .../commands/{statistics => }/crosstabs.md | 0 .../src/commands/{statistics => }/ctables.md | 17 +- .../commands/{data-io/index.md => data-io.md} | 0 .../src/commands/{data-io => }/data-list.md | 35 ++- .../src/commands/{data/index.md => data.md} | 2 + .../{data-io => }/datafile-attribute.md | 2 +- .../doc/src/commands/{data-io => }/dataset.md | 2 +- rust/doc/src/commands/{control => }/define.md | 37 ++- .../{variables => }/delete-variables.md | 3 +- .../commands/{statistics => }/descriptives.md | 4 +- .../{utilities => }/display-documents.md | 0 .../{utilities => }/display-file-label.md | 0 .../src/commands/{variables => }/display.md | 8 +- rust/doc/src/commands/{control => }/do-if.md | 6 +- .../src/commands/{control => }/do-repeat.md | 0 .../src/commands/{utilities => }/document.md | 0 .../{utilities => }/drop-documents.md | 0 rust/doc/src/commands/{utilities => }/echo.md | 3 +- .../src/commands/{data-io => }/end-case.md | 0 .../src/commands/{data-io => }/end-file.md | 0 .../doc/src/commands/{utilities => }/erase.md | 2 +- .../src/commands/{statistics => }/examine.md | 0 .../src/commands/{utilities => }/execute.md | 0 rust/doc/src/commands/{spss-io => }/export.md | 4 +- .../src/commands/{statistics => }/factor.md | 14 +- .../src/commands/{data-io => }/file-handle.md | 10 +- .../commands/{utilities => }/file-label.md | 0 .../src/commands/{selection => }/filter.md | 0 .../src/commands/{utilities => }/finish.md | 0 rust/doc/src/commands/{data => }/flip.md | 11 +- .../src/commands/{variables => }/formats.md | 3 +- .../commands/{statistics => }/frequencies.md | 0 .../src/commands/{spss-io => }/get-data.md | 23 +- rust/doc/src/commands/{spss-io => }/get.md | 3 +- rust/doc/src/commands/{statistics => }/glm.md | 0 .../src/commands/{statistics => }/graph.md | 0 rust/doc/src/commands/{utilities => }/host.md | 4 +- rust/doc/src/commands/{data => }/if.md | 17 +- rust/doc/src/commands/{spss-io => }/import.md | 3 +- .../src/commands/{utilities => }/include.md | 0 .../commands/{data-io => }/input-program.md | 3 +- .../src/commands/{utilities => }/insert.md | 9 +- .../doc/src/commands/{variables => }/leave.md | 0 rust/doc/src/commands/{data-io => }/list.md | 0 .../{statistics => }/logistic-regression.md | 0 rust/doc/src/commands/{control => }/loop.md | 16 +- .../commands/{combining => }/match-files.md | 2 +- .../commands/{matrix/index.md => matrices.md} | 3 +- .../src/commands/{matrix => }/matrix-data.md | 19 +- rust/doc/src/commands/{matrix => }/matrix.md | 30 +-- .../doc/src/commands/{matrix => }/mconvert.md | 0 .../src/commands/{statistics => }/means.md | 0 .../{variables => }/missing-values.md | 3 +- .../src/commands/{variables => }/mrsets.md | 3 +- rust/doc/src/commands/{selection => }/n.md | 0 .../src/commands/{data-io => }/new-file.md | 0 .../commands/{statistics => }/npar-tests.md | 0 .../src/commands/{variables => }/numeric.md | 3 +- .../src/commands/{statistics => }/oneway.md | 0 .../src/commands/{utilities => }/output.md | 3 +- .../commands/{utilities => }/permissions.md | 8 +- .../src/commands/{utilities => }/preserve.md | 0 .../src/commands/{data-io => }/print-eject.md | 0 .../commands/{variables => }/print-formats.md | 0 .../src/commands/{data-io => }/print-space.md | 7 +- rust/doc/src/commands/{data-io => }/print.md | 8 +- .../{statistics => }/quick-cluster.md | 0 .../doc/src/commands/{statistics => }/rank.md | 0 rust/doc/src/commands/{data => }/recode.md | 0 .../commands/{statistics => }/regression.md | 0 .../commands/{statistics => }/reliability.md | 5 +- .../{variables => }/rename-variables.md | 2 +- .../commands/{data-io => }/repeating-data.md | 7 +- rust/doc/src/commands/{data-io => }/reread.md | 9 +- rust/doc/src/commands/{statistics => }/roc.md | 0 .../src/commands/{selection => }/sample.md | 0 .../{spss-io => }/save-data-collection.md | 3 +- .../commands/{spss-io => }/save-translate.md | 7 +- rust/doc/src/commands/{spss-io => }/save.md | 7 +- .../src/commands/{selection => }/select-if.md | 6 +- .../{selection/index.md => selection.md} | 0 rust/doc/src/commands/{utilities => }/set.md | 66 +++-- rust/doc/src/commands/{utilities => }/show.md | 2 +- .../doc/src/commands/{data => }/sort-cases.md | 3 +- .../{variables => }/sort-variables.md | 0 .../commands/{selection => }/split-file.md | 13 +- .../commands/{spss-io/index.md => spss-io.md} | 0 .../{statistics/index.md => statistics.md} | 2 + .../src/commands/{variables => }/string.md | 3 +- .../src/commands/{utilities => }/subtitle.md | 0 .../commands/{spss-io => }/sysfile-info.md | 0 .../src/commands/{statistics => }/t-test.md | 0 .../src/commands/{selection => }/temporary.md | 0 .../doc/src/commands/{utilities => }/title.md | 0 .../src/commands/{combining => }/update.md | 2 +- .../{utilities/index.md => utilities.md} | 0 .../commands/{variables => }/value-labels.md | 0 .../{variables => }/variable-alignment.md | 0 .../{variables => }/variable-attribute.md | 5 +- .../{variables => }/variable-labels.md | 0 rust/doc/src/commands/variable-level.md | 10 + .../commands/{variables => }/variable-role.md | 0 .../{variables => }/variable-width.md | 0 .../{variables/index.md => variables.md} | 3 +- .../src/commands/variables/variable-level.md | 9 - .../src/commands/{variables => }/vector.md | 3 +- .../src/commands/{selection => }/weight.md | 5 +- .../commands/{variables => }/write-formats.md | 0 rust/doc/src/commands/{data-io => }/write.md | 0 .../doc/src/commands/{spss-io => }/xexport.md | 0 rust/doc/src/commands/{spss-io => }/xsave.md | 0 rust/doc/src/data/aggregate.md | 16 +- rust/doc/src/invoking/pspp-show.md | 4 +- .../src/language/datasets/formats/basic.md | 6 +- .../datasets/formats/binary-and-hex.md | 15 +- .../src/language/datasets/formats/index.md | 12 +- .../datasets/formats/legacy-numeric.md | 2 +- .../datasets/formats/time-and-date.md | 8 +- rust/doc/src/language/datasets/index.md | 4 +- .../language/datasets/scratch-variables.md | 8 +- rust/doc/src/language/datasets/variables.md | 50 ++-- .../expressions/functions/mathematical.md | 8 +- .../expressions/functions/statistical.md | 4 +- .../expressions/functions/time-and-date.md | 4 +- rust/doc/src/language/files/file-handles.md | 6 +- rust/doc/src/language/files/index.md | 4 +- rust/doc/src/language/tutorial/hypotheses.md | 6 +- rust/doc/src/language/tutorial/preparation.md | 18 +- .../src/language/tutorial/transformations.md | 38 ++- rust/doc/src/pc+.md | 4 +- rust/doc/src/spv/light-detail.md | 4 +- 148 files changed, 534 insertions(+), 538 deletions(-) rename rust/doc/src/commands/{utilities => }/add-document.md (100%) rename rust/doc/src/commands/{combining => }/add-files.md (95%) rename rust/doc/src/commands/{variables => }/add-value-labels.md (100%) rename rust/doc/src/commands/{data => }/aggregate.md (95%) rename rust/doc/src/commands/{spss-io => }/apply-dictionary.md (75%) rename rust/doc/src/commands/{data => }/autorecode.md (100%) rename rust/doc/src/commands/{data-io => }/begin-data.md (100%) rename rust/doc/src/commands/{control => }/break.md (100%) rename rust/doc/src/commands/{utilities => }/cache.md (100%) rename rust/doc/src/commands/{utilities => }/cd.md (100%) rename rust/doc/src/commands/{data-io => }/close-file-handle.md (85%) rename rust/doc/src/commands/{combining/index.md => combining.md} (90%) rename rust/doc/src/commands/{utilities => }/comment.md (100%) rename rust/doc/src/commands/{data => }/compute.md (77%) rename rust/doc/src/commands/{control/index.md => control.md} (79%) rename rust/doc/src/commands/{statistics => }/correlations.md (100%) rename rust/doc/src/commands/{statistics => }/crosstabs.md (100%) rename rust/doc/src/commands/{statistics => }/ctables.md (99%) rename rust/doc/src/commands/{data-io/index.md => data-io.md} (100%) rename rust/doc/src/commands/{data-io => }/data-list.md (89%) rename rust/doc/src/commands/{data/index.md => data.md} (86%) rename rust/doc/src/commands/{data-io => }/datafile-attribute.md (97%) rename rust/doc/src/commands/{data-io => }/dataset.md (98%) rename rust/doc/src/commands/{control => }/define.md (95%) rename rust/doc/src/commands/{variables => }/delete-variables.md (85%) rename rust/doc/src/commands/{statistics => }/descriptives.md (98%) rename rust/doc/src/commands/{utilities => }/display-documents.md (100%) rename rust/doc/src/commands/{utilities => }/display-file-label.md (100%) rename rust/doc/src/commands/{variables => }/display.md (89%) rename rust/doc/src/commands/{control => }/do-if.md (82%) rename rust/doc/src/commands/{control => }/do-repeat.md (100%) rename rust/doc/src/commands/{utilities => }/document.md (100%) rename rust/doc/src/commands/{utilities => }/drop-documents.md (100%) rename rust/doc/src/commands/{utilities => }/echo.md (61%) rename rust/doc/src/commands/{data-io => }/end-case.md (100%) rename rust/doc/src/commands/{data-io => }/end-file.md (100%) rename rust/doc/src/commands/{utilities => }/erase.md (75%) rename rust/doc/src/commands/{statistics => }/examine.md (100%) rename rust/doc/src/commands/{utilities => }/execute.md (100%) rename rust/doc/src/commands/{spss-io => }/export.md (92%) rename rust/doc/src/commands/{statistics => }/factor.md (92%) rename rust/doc/src/commands/{data-io => }/file-handle.md (95%) rename rust/doc/src/commands/{utilities => }/file-label.md (100%) rename rust/doc/src/commands/{selection => }/filter.md (100%) rename rust/doc/src/commands/{utilities => }/finish.md (100%) rename rust/doc/src/commands/{data => }/flip.md (95%) rename rust/doc/src/commands/{variables => }/formats.md (86%) rename rust/doc/src/commands/{statistics => }/frequencies.md (100%) rename rust/doc/src/commands/{spss-io => }/get-data.md (95%) rename rust/doc/src/commands/{spss-io => }/get.md (96%) rename rust/doc/src/commands/{statistics => }/glm.md (100%) rename rust/doc/src/commands/{statistics => }/graph.md (100%) rename rust/doc/src/commands/{utilities => }/host.md (94%) rename rust/doc/src/commands/{data => }/if.md (67%) rename rust/doc/src/commands/{spss-io => }/import.md (88%) rename rust/doc/src/commands/{utilities => }/include.md (100%) rename rust/doc/src/commands/{data-io => }/input-program.md (96%) rename rust/doc/src/commands/{utilities => }/insert.md (89%) rename rust/doc/src/commands/{variables => }/leave.md (100%) rename rust/doc/src/commands/{data-io => }/list.md (100%) rename rust/doc/src/commands/{statistics => }/logistic-regression.md (100%) rename rust/doc/src/commands/{control => }/loop.md (84%) rename rust/doc/src/commands/{combining => }/match-files.md (97%) rename rust/doc/src/commands/{matrix/index.md => matrices.md} (97%) rename rust/doc/src/commands/{matrix => }/matrix-data.md (95%) rename rust/doc/src/commands/{matrix => }/matrix.md (98%) rename rust/doc/src/commands/{matrix => }/mconvert.md (100%) rename rust/doc/src/commands/{statistics => }/means.md (100%) rename rust/doc/src/commands/{variables => }/missing-values.md (91%) rename rust/doc/src/commands/{variables => }/mrsets.md (96%) rename rust/doc/src/commands/{selection => }/n.md (100%) rename rust/doc/src/commands/{data-io => }/new-file.md (100%) rename rust/doc/src/commands/{statistics => }/npar-tests.md (100%) rename rust/doc/src/commands/{variables => }/numeric.md (77%) rename rust/doc/src/commands/{statistics => }/oneway.md (100%) rename rust/doc/src/commands/{utilities => }/output.md (91%) rename rust/doc/src/commands/{utilities => }/permissions.md (72%) rename rust/doc/src/commands/{utilities => }/preserve.md (100%) rename rust/doc/src/commands/{data-io => }/print-eject.md (100%) rename rust/doc/src/commands/{variables => }/print-formats.md (100%) rename rust/doc/src/commands/{data-io => }/print-space.md (71%) rename rust/doc/src/commands/{data-io => }/print.md (92%) rename rust/doc/src/commands/{statistics => }/quick-cluster.md (100%) rename rust/doc/src/commands/{statistics => }/rank.md (100%) rename rust/doc/src/commands/{data => }/recode.md (100%) rename rust/doc/src/commands/{statistics => }/regression.md (100%) rename rust/doc/src/commands/{statistics => }/reliability.md (95%) rename rust/doc/src/commands/{variables => }/rename-variables.md (94%) rename rust/doc/src/commands/{data-io => }/repeating-data.md (93%) rename rust/doc/src/commands/{data-io => }/reread.md (75%) rename rust/doc/src/commands/{statistics => }/roc.md (100%) rename rust/doc/src/commands/{selection => }/sample.md (100%) rename rust/doc/src/commands/{spss-io => }/save-data-collection.md (92%) rename rust/doc/src/commands/{spss-io => }/save-translate.md (95%) rename rust/doc/src/commands/{spss-io => }/save.md (94%) rename rust/doc/src/commands/{selection => }/select-if.md (93%) rename rust/doc/src/commands/{selection/index.md => selection.md} (100%) rename rust/doc/src/commands/{utilities => }/set.md (86%) rename rust/doc/src/commands/{utilities => }/show.md (95%) rename rust/doc/src/commands/{data => }/sort-cases.md (98%) rename rust/doc/src/commands/{variables => }/sort-variables.md (100%) rename rust/doc/src/commands/{selection => }/split-file.md (93%) rename rust/doc/src/commands/{spss-io/index.md => spss-io.md} (100%) rename rust/doc/src/commands/{statistics/index.md => statistics.md} (83%) rename rust/doc/src/commands/{variables => }/string.md (88%) rename rust/doc/src/commands/{utilities => }/subtitle.md (100%) rename rust/doc/src/commands/{spss-io => }/sysfile-info.md (100%) rename rust/doc/src/commands/{statistics => }/t-test.md (100%) rename rust/doc/src/commands/{selection => }/temporary.md (100%) rename rust/doc/src/commands/{utilities => }/title.md (100%) rename rust/doc/src/commands/{combining => }/update.md (97%) rename rust/doc/src/commands/{utilities/index.md => utilities.md} (100%) rename rust/doc/src/commands/{variables => }/value-labels.md (100%) rename rust/doc/src/commands/{variables => }/variable-alignment.md (100%) rename rust/doc/src/commands/{variables => }/variable-attribute.md (92%) rename rust/doc/src/commands/{variables => }/variable-labels.md (100%) create mode 100644 rust/doc/src/commands/variable-level.md rename rust/doc/src/commands/{variables => }/variable-role.md (100%) rename rust/doc/src/commands/{variables => }/variable-width.md (100%) rename rust/doc/src/commands/{variables/index.md => variables.md} (71%) delete mode 100644 rust/doc/src/commands/variables/variable-level.md rename rust/doc/src/commands/{variables => }/vector.md (92%) rename rust/doc/src/commands/{selection => }/weight.md (96%) rename rust/doc/src/commands/{variables => }/write-formats.md (100%) rename rust/doc/src/commands/{data-io => }/write.md (100%) rename rust/doc/src/commands/{spss-io => }/xexport.md (100%) rename rust/doc/src/commands/{spss-io => }/xsave.md (100%) diff --git a/rust/doc/src/SUMMARY.md b/rust/doc/src/SUMMARY.md index bc4f8640bd..5fde2b517d 100644 --- a/rust/doc/src/SUMMARY.md +++ b/rust/doc/src/SUMMARY.md @@ -50,132 +50,132 @@ # Command Syntax -- [Working with Text Files](commands/data-io/index.md) - - [BEGIN DATA…END DATA](commands/data-io/begin-data.md) - - [CLOSE FILE HANDLE](commands/data-io/close-file-handle.md) - - [DATAFILE ATTRIBUTE](commands/data-io/datafile-attribute.md) - - [DATASET commands](commands/data-io/dataset.md) - - [DATA LIST](commands/data-io/data-list.md) - - [END CASE](commands/data-io/end-case.md) - - [END FILE](commands/data-io/end-file.md) - - [FILE HANDLE](commands/data-io/file-handle.md) - - [INPUT PROGRAM…END INPUT PROGRAM](commands/data-io/input-program.md) - - [LIST](commands/data-io/list.md) - - [NEW FILE](commands/data-io/new-file.md) - - [PRINT](commands/data-io/print.md) - - [PRINT EJECT](commands/data-io/print-eject.md) - - [PRINT SPACE](commands/data-io/print-space.md) - - [REREAD](commands/data-io/reread.md) - - [REPEATING DATA](commands/data-io/repeating-data.md) - - [WRITE](commands/data-io/write.md) -- [Working with Data Files](commands/spss-io/index.md) - - [APPLY DICTIONARY](commands/spss-io/apply-dictionary.md) - - [EXPORT](commands/spss-io/export.md) - - [GET](commands/spss-io/get.md) - - [GET DATA](commands/spss-io/get-data.md) - - [IMPORT](commands/spss-io/import.md) - - [SAVE](commands/spss-io/save.md) - - [SAVE DATA COLLECTION](commands/spss-io/save-data-collection.md) - - [SAVE TRANSLATE](commands/spss-io/save-translate.md) - - [SYSFILE INFO](commands/spss-io/sysfile-info.md) - - [XEXPORT](commands/spss-io/xexport.md) - - [XSAVE](commands/spss-io/xsave.md) -- [Combining Data Files](commands/combining/index.md) - - [ADD FILES](commands/combining/add-files.md) - - [MATCH FILES](commands/combining/match-files.md) - - [UPDATE](commands/combining/update.md) -- [Manipulating Variables](commands/variables/index.md) - - [ADD VALUE LABELS](commands/variables/add-value-labels.md) - - [DELETE VARIABLES](commands/variables/delete-variables.md) - - [DISPLAY](commands/variables/display.md) - - [FORMATS](commands/variables/formats.md) - - [LEAVE](commands/variables/leave.md) - - [MISSING VALUES](commands/variables/missing-values.md) - - [MRSETS](commands/variables/mrsets.md) - - [NUMERIC](commands/variables/numeric.md) - - [PRINT FORMATS](commands/variables/print-formats.md) - - [RENAME VARIABLES](commands/variables/rename-variables.md) - - [SORT VARIABLES](commands/variables/sort-variables.md) - - [STRING](commands/variables/string.md) - - [VALUE LABELS](commands/variables/value-labels.md) - - [VARIABLE ALIGNMENT](commands/variables/variable-alignment.md) - - [VARIABLE ATTRIBUTE](commands/variables/variable-attribute.md) - - [VARIABLE LABELS](commands/variables/variable-labels.md) - - [VARIABLE LEVEL](commands/variables/variable-level.md) - - [VARIABLE ROLE](commands/variables/variable-role.md) - - [VARIABLE WIDTH](commands/variables/variable-width.md) - - [VECTOR](commands/variables/vector.md) - - [WRITE FORMATS](commands/variables/write-formats.md) -- [Transforming Data](commands/data/index.md) - - [AGGREGATE](commands/data/aggregate.md) - - [AUTORECODE](commands/data/autorecode.md) - - [COMPUTE](commands/data/compute.md) - - [FLIP](commands/data/flip.md) - - [IF](commands/data/if.md) - - [RECODE](commands/data/recode.md) - - [SORT CASES](commands/data/sort-cases.md) -- [Selecting Data](commands/selection/index.md) - - [FILTER](commands/selection/filter.md) - - [N OF CASES](commands/selection/n.md) - - [SAMPLE](commands/selection/sample.md) - - [SELECT IF](commands/selection/select-if.md) - - [SPLIT FILE](commands/selection/split-file.md) - - [TEMPORARY](commands/selection/temporary.md) - - [WEIGHT](commands/selection/weight.md) -- [Conditionals and Loops](commands/control/index.md) - - [BREAK](commands/control/break.md) - - [DEFINE…!ENDDEFINE](commands/control/define.md) - - [DO IF…END IF](commands/control/do-if.md) - - [DO REPEAT…END REPEAT](commands/control/do-repeat.md) - - [LOOP…END LOOP](commands/control/loop.md) -- [Statistics](commands/statistics/index.md) - - [DESCRIPTIVES](commands/statistics/descriptives.md) - - [FREQUENCIES](commands/statistics/frequencies.md) - - [EXAMINE](commands/statistics/examine.md) - - [GRAPH](commands/statistics/graph.md) - - [CORRELATIONS](commands/statistics/correlations.md) - - [CROSSTABS](commands/statistics/crosstabs.md) - - [CTABLES](commands/statistics/ctables.md) - - [FACTOR](commands/statistics/factor.md) - - [GLM](commands/statistics/glm.md) - - [LOGISTIC REGRESSION](commands/statistics/logistic-regression.md) - - [MEANS](commands/statistics/means.md) - - [NPAR TESTS](commands/statistics/npar-tests.md) - - [T-TEST](commands/statistics/t-test.md) - - [ONEWAY](commands/statistics/oneway.md) - - [QUICK CLUSTER](commands/statistics/quick-cluster.md) - - [RANK](commands/statistics/rank.md) - - [REGRESSION](commands/statistics/regression.md) - - [RELIABILITY](commands/statistics/reliability.md) - - [ROC](commands/statistics/roc.md) -- [Matrices](commands/matrix/index.md) - - [MATRIX DATA](commands/matrix/matrix-data.md) - - [MCONVERT](commands/matrix/mconvert.md) - - [MATRIX…END MATRIX](commands/matrix/matrix.md) -- [Utilities](commands/utilities/index.md) - - [ADD DOCUMENT](commands/utilities/add-document.md) - - [CACHE](commands/utilities/cache.md) - - [CD](commands/utilities/cd.md) - - [COMMENT](commands/utilities/comment.md) - - [DOCUMENT](commands/utilities/document.md) - - [DISPLAY DOCUMENTS](commands/utilities/display-documents.md) - - [DISPLAY FILE LABEL](commands/utilities/display-file-label.md) - - [DROP DOCUMENTS](commands/utilities/drop-documents.md) - - [ECHO](commands/utilities/echo.md) - - [ERASE](commands/utilities/erase.md) - - [EXECUTE](commands/utilities/execute.md) - - [FILE LABEL](commands/utilities/file-label.md) - - [FINISH](commands/utilities/finish.md) - - [HOST](commands/utilities/host.md) - - [INCLUDE](commands/utilities/include.md) - - [INSERT](commands/utilities/insert.md) - - [OUTPUT](commands/utilities/output.md) - - [PERMISSIONS](commands/utilities/permissions.md) - - [PRESERVE…RESTORE](commands/utilities/preserve.md) - - [SET](commands/utilities/set.md) - - [SHOW](commands/utilities/show.md) - - [SUBTITLE](commands/utilities/subtitle.md) - - [TITLE](commands/utilities/title.md) +- [Working with Text Files](commands/data-io.md) + - [BEGIN DATA…END DATA](commands/begin-data.md) + - [CLOSE FILE HANDLE](commands/close-file-handle.md) + - [DATAFILE ATTRIBUTE](commands/datafile-attribute.md) + - [DATASET commands](commands/dataset.md) + - [DATA LIST](commands/data-list.md) + - [END CASE](commands/end-case.md) + - [END FILE](commands/end-file.md) + - [FILE HANDLE](commands/file-handle.md) + - [INPUT PROGRAM…END INPUT PROGRAM](commands/input-program.md) + - [LIST](commands/list.md) + - [NEW FILE](commands/new-file.md) + - [PRINT](commands/print.md) + - [PRINT EJECT](commands/print-eject.md) + - [PRINT SPACE](commands/print-space.md) + - [REREAD](commands/reread.md) + - [REPEATING DATA](commands/repeating-data.md) + - [WRITE](commands/write.md) +- [Working with Data Files](commands/spss-io.md) + - [APPLY DICTIONARY](commands/apply-dictionary.md) + - [EXPORT](commands/export.md) + - [GET](commands/get.md) + - [GET DATA](commands/get-data.md) + - [IMPORT](commands/import.md) + - [SAVE](commands/save.md) + - [SAVE DATA COLLECTION](commands/save-data-collection.md) + - [SAVE TRANSLATE](commands/save-translate.md) + - [SYSFILE INFO](commands/sysfile-info.md) + - [XEXPORT](commands/xexport.md) + - [XSAVE](commands/xsave.md) +- [Combining Data Files](commands/combining.md) + - [ADD FILES](commands/add-files.md) + - [MATCH FILES](commands/match-files.md) + - [UPDATE](commands/update.md) +- [Manipulating Variables](commands/variables.md) + - [ADD VALUE LABELS](commands/add-value-labels.md) + - [DELETE VARIABLES](commands/delete-variables.md) + - [DISPLAY](commands/display.md) + - [FORMATS](commands/formats.md) + - [LEAVE](commands/leave.md) + - [MISSING VALUES](commands/missing-values.md) + - [MRSETS](commands/mrsets.md) + - [NUMERIC](commands/numeric.md) + - [PRINT FORMATS](commands/print-formats.md) + - [RENAME VARIABLES](commands/rename-variables.md) + - [SORT VARIABLES](commands/sort-variables.md) + - [STRING](commands/string.md) + - [VALUE LABELS](commands/value-labels.md) + - [VARIABLE ALIGNMENT](commands/variable-alignment.md) + - [VARIABLE ATTRIBUTE](commands/variable-attribute.md) + - [VARIABLE LABELS](commands/variable-labels.md) + - [VARIABLE LEVEL](commands/variable-level.md) + - [VARIABLE ROLE](commands/variable-role.md) + - [VARIABLE WIDTH](commands/variable-width.md) + - [VECTOR](commands/vector.md) + - [WRITE FORMATS](commands/write-formats.md) +- [Transforming Data](commands/data.md) + - [AGGREGATE](commands/aggregate.md) + - [AUTORECODE](commands/autorecode.md) + - [COMPUTE](commands/compute.md) + - [FLIP](commands/flip.md) + - [IF](commands/if.md) + - [RECODE](commands/recode.md) + - [SORT CASES](commands/sort-cases.md) +- [Selecting Data](commands/selection.md) + - [FILTER](commands/filter.md) + - [N OF CASES](commands/n.md) + - [SAMPLE](commands/sample.md) + - [SELECT IF](commands/select-if.md) + - [SPLIT FILE](commands/split-file.md) + - [TEMPORARY](commands/temporary.md) + - [WEIGHT](commands/weight.md) +- [Conditionals and Loops](commands/control.md) + - [BREAK](commands/break.md) + - [DEFINE…!ENDDEFINE](commands/define.md) + - [DO IF…END IF](commands/do-if.md) + - [DO REPEAT…END REPEAT](commands/do-repeat.md) + - [LOOP…END LOOP](commands/loop.md) +- [Statistics](commands/statistics.md) + - [DESCRIPTIVES](commands/descriptives.md) + - [FREQUENCIES](commands/frequencies.md) + - [EXAMINE](commands/examine.md) + - [GRAPH](commands/graph.md) + - [CORRELATIONS](commands/correlations.md) + - [CROSSTABS](commands/crosstabs.md) + - [CTABLES](commands/ctables.md) + - [FACTOR](commands/factor.md) + - [GLM](commands/glm.md) + - [LOGISTIC REGRESSION](commands/logistic-regression.md) + - [MEANS](commands/means.md) + - [NPAR TESTS](commands/npar-tests.md) + - [T-TEST](commands/t-test.md) + - [ONEWAY](commands/oneway.md) + - [QUICK CLUSTER](commands/quick-cluster.md) + - [RANK](commands/rank.md) + - [REGRESSION](commands/regression.md) + - [RELIABILITY](commands/reliability.md) + - [ROC](commands/roc.md) +- [Matrices](commands/matrices.md) + - [MATRIX DATA](commands/matrix-data.md) + - [MCONVERT](commands/mconvert.md) + - [MATRIX…END MATRIX](commands/matrix.md) +- [Utilities](commands/utilities.md) + - [ADD DOCUMENT](commands/add-document.md) + - [CACHE](commands/cache.md) + - [CD](commands/cd.md) + - [COMMENT](commands/comment.md) + - [DOCUMENT](commands/document.md) + - [DISPLAY DOCUMENTS](commands/display-documents.md) + - [DISPLAY FILE LABEL](commands/display-file-label.md) + - [DROP DOCUMENTS](commands/drop-documents.md) + - [ECHO](commands/echo.md) + - [ERASE](commands/erase.md) + - [EXECUTE](commands/execute.md) + - [FILE LABEL](commands/file-label.md) + - [FINISH](commands/finish.md) + - [HOST](commands/host.md) + - [INCLUDE](commands/include.md) + - [INSERT](commands/insert.md) + - [OUTPUT](commands/output.md) + - [PERMISSIONS](commands/permissions.md) + - [PRESERVE…RESTORE](commands/preserve.md) + - [SET](commands/set.md) + - [SHOW](commands/show.md) + - [SUBTITLE](commands/subtitle.md) + - [TITLE](commands/title.md) # Developer Documentation diff --git a/rust/doc/src/commands/utilities/add-document.md b/rust/doc/src/commands/add-document.md similarity index 100% rename from rust/doc/src/commands/utilities/add-document.md rename to rust/doc/src/commands/add-document.md diff --git a/rust/doc/src/commands/combining/add-files.md b/rust/doc/src/commands/add-files.md similarity index 95% rename from rust/doc/src/commands/combining/add-files.md rename to rust/doc/src/commands/add-files.md index 38837144fd..eac7ad8ae2 100644 --- a/rust/doc/src/commands/combining/add-files.md +++ b/rust/doc/src/commands/add-files.md @@ -24,7 +24,7 @@ input files. `ADD FILES` shares the bulk of its syntax with other PSPP commands for combining multiple data files (see [Common -Syntax](index.md#common-syntax) for details). +Syntax](combining.md#common-syntax) for details). When `BY` is not used, the output of `ADD FILES` consists of all the cases from the first input file specified, followed by all the cases diff --git a/rust/doc/src/commands/variables/add-value-labels.md b/rust/doc/src/commands/add-value-labels.md similarity index 100% rename from rust/doc/src/commands/variables/add-value-labels.md rename to rust/doc/src/commands/add-value-labels.md diff --git a/rust/doc/src/commands/data/aggregate.md b/rust/doc/src/commands/aggregate.md similarity index 95% rename from rust/doc/src/commands/data/aggregate.md rename to rust/doc/src/commands/aggregate.md index 6905ef4df9..ca1a38517b 100644 --- a/rust/doc/src/commands/data/aggregate.md +++ b/rust/doc/src/commands/aggregate.md @@ -22,8 +22,8 @@ function to define how it is calculated. The `OUTFILE` subcommand, which must be first, names the destination for `AGGREGATE` output. It may name a system file by file name or -[file handle](../../language/files/file-handles.md), a -[dataset](../../language/datasets/index.md) by its name, or `*` to +[file handle](../language/files/file-handles.md), a +[dataset](../language/datasets/index.md) by its name, or `*` to replace the active dataset. `AGGREGATE` writes its output to this file. @@ -50,10 +50,10 @@ If the active dataset is already sorted or grouped by the break variables, specify `PRESORTED` to save time. With `MODE=ADDVARIABLES`, the data must be pre-sorted. -Specify [`DOCUMENT`](../utilities/document.md) to copy the documents -from the active dataset into the aggregate file. Otherwise, the -aggregate file does not contain any documents, even if the aggregate -file replaces the active dataset. +Specify [`DOCUMENT`](document.md) to copy the documents from the +active dataset into the aggregate file. Otherwise, the aggregate file +does not contain any documents, even if the aggregate file replaces +the active dataset. Normally, `AGGREGATE` produces a non-missing value whenever there is enough non-missing data for the aggregation function in use, that is, @@ -145,7 +145,7 @@ variables: `NMISS(VAR_NAME...)` Total weight of non-missing or missing values, respectively. The default format is `F7.0` if weighting is not enabled, `F8.2` if it - is (see [`WEIGHT`](../selection/weight.md)). + is (see [`WEIGHT`](weight.md)). * `NU(VAR_NAME...)` `NUMISS(VAR_NAME...)` @@ -165,7 +165,7 @@ These aggregation functions do not accept source variables: * `N` Total weight of cases aggregated to form this group. The default format is `F7.0` if weighting is not enabled, `F8.2` if it is (see - [`WEIGHT`](../selection/weight.md)). + [`WEIGHT`](weight.md)). * `NU` Count of cases aggregated to form this group, ignoring case @@ -181,7 +181,7 @@ specifying such a function as the last token on a line causes the period to be interpreted as the end of the command.) `AGGREGATE` both ignores and cancels the current [`SPLIT -FILE`](../selection/split-file.md) settings. +FILE`](split-file.md) settings. ## Example diff --git a/rust/doc/src/commands/spss-io/apply-dictionary.md b/rust/doc/src/commands/apply-dictionary.md similarity index 75% rename from rust/doc/src/commands/spss-io/apply-dictionary.md rename to rust/doc/src/commands/apply-dictionary.md index 705843d13c..cec28fb5ae 100644 --- a/rust/doc/src/commands/spss-io/apply-dictionary.md +++ b/rust/doc/src/commands/apply-dictionary.md @@ -10,7 +10,7 @@ active dataset. In some cases it also updates the weighting variable. The `FROM` clause is mandatory. Use it to specify a system file or portable file's name in single quotes, or a [file handle -name](../../language/files/file-handles.md). The dictionary in the +name](../language/files/file-handles.md). The dictionary in the file is read, but it does not replace the active dataset's dictionary. The file's data is not read. @@ -26,7 +26,7 @@ active dataset variables: dataset variable's variable label, if any, is retained. - If the system file variable has [variable - attributes](../variables/variable-attribute.md), then those + attributes](variable-attribute.md), then those attributes replace the active dataset variable's variable attributes. If the system file variable does not have varaible attributes, then the active dataset variable's variable attributes, @@ -42,16 +42,15 @@ In addition to properties of variables, some properties of the active file dictionary as a whole are updated: - If the system file has custom attributes (see [DATAFILE - ATTRIBUTE](../../commands/data-io/datafile-attribute.html)), then - those attributes replace the active dataset variable's custom - attributes. - -- If the active dataset has a [weight - variable](../selection/weight.md), and the system file does not, or - if the weighting variable in the system file does not exist in the - active dataset, then the active dataset weighting variable, if any, - is retained. Otherwise, the weighting variable in the system file - becomes the active dataset weighting variable. + ATTRIBUTE](datafile-attribute.html)), then those attributes replace + the active dataset variable's custom attributes. + +- If the active dataset has a [weight variable](weight.md), and the + system file does not, or if the weighting variable in the system + file does not exist in the active dataset, then the active dataset + weighting variable, if any, is retained. Otherwise, the weighting + variable in the system file becomes the active dataset weighting + variable. `APPLY DICTIONARY` takes effect immediately. It does not read the active dataset. The system file is not modified. diff --git a/rust/doc/src/commands/data/autorecode.md b/rust/doc/src/commands/autorecode.md similarity index 100% rename from rust/doc/src/commands/data/autorecode.md rename to rust/doc/src/commands/autorecode.md diff --git a/rust/doc/src/commands/data-io/begin-data.md b/rust/doc/src/commands/begin-data.md similarity index 100% rename from rust/doc/src/commands/data-io/begin-data.md rename to rust/doc/src/commands/begin-data.md diff --git a/rust/doc/src/commands/control/break.md b/rust/doc/src/commands/break.md similarity index 100% rename from rust/doc/src/commands/control/break.md rename to rust/doc/src/commands/break.md diff --git a/rust/doc/src/commands/utilities/cache.md b/rust/doc/src/commands/cache.md similarity index 100% rename from rust/doc/src/commands/utilities/cache.md rename to rust/doc/src/commands/cache.md diff --git a/rust/doc/src/commands/utilities/cd.md b/rust/doc/src/commands/cd.md similarity index 100% rename from rust/doc/src/commands/utilities/cd.md rename to rust/doc/src/commands/cd.md diff --git a/rust/doc/src/commands/data-io/close-file-handle.md b/rust/doc/src/commands/close-file-handle.md similarity index 85% rename from rust/doc/src/commands/data-io/close-file-handle.md rename to rust/doc/src/commands/close-file-handle.md index e73a569ed2..76a707f71c 100644 --- a/rust/doc/src/commands/data-io/close-file-handle.md +++ b/rust/doc/src/commands/close-file-handle.md @@ -5,7 +5,7 @@ CLOSE FILE HANDLE HANDLE_NAME. ``` `CLOSE FILE HANDLE` disassociates the name of a [file -handle](../../language/files/file-handles.md) with a given file. The +handle](../language/files/file-handles.md) with a given file. The only specification is the name of the handle to close. Afterward `FILE HANDLE`. diff --git a/rust/doc/src/commands/combining/index.md b/rust/doc/src/commands/combining.md similarity index 90% rename from rust/doc/src/commands/combining/index.md rename to rust/doc/src/commands/combining.md index 17d7708ebe..b34d04df19 100644 --- a/rust/doc/src/commands/combining/index.md +++ b/rust/doc/src/commands/combining.md @@ -48,10 +48,10 @@ an appropriate procedure or transformation. The syntax of each command begins with a specification of the files to be read as input. For each input file, specify `FILE` with a system file or portable file's name as a string, a -[dataset](../../language/datasets/index.md) or [file -handle](../../language/files/file-handles.md) name, or an asterisk -(`*`) to use the active dataset as input. Use of portable files on -`FILE` is a PSPP extension. +[dataset](../language/datasets/index.md) or [file +handle](../language/files/file-handles.md) name, or an asterisk (`*`) +to use the active dataset as input. Use of portable files on `FILE` +is a PSPP extension. At least two `FILE` subcommands must be specified. If the active dataset is used as an input source, then `TEMPORARY` must not be in @@ -97,12 +97,12 @@ dictionary of the new active dataset, like so: specified input file that has a variable label for that variable, and similarly for value labels and missing values. -- The [file label](../utilities/file-label.md) of the new active - dataset is that of the first specified `FILE` that has a file label. +- The [file label](file-label.md) of the new active dataset is that of + the first specified `FILE` that has a file label. -- The [documents](../utilities/document.md) in the new active dataset - are the concatenation of all the input files' documents, in the - order in which the `FILE` subcommands are specified. +- The [documents](document.md) in the new active dataset are the + concatenation of all the input files' documents, in the order in + which the `FILE` subcommands are specified. - If all of the input files are weighted on the same variable, then the new active dataset is weighted on that variable. Otherwise, @@ -120,8 +120,8 @@ variables, then `SORT` must be specified for those input files. The variables listed on `BY` may include `(A)` or `(D)` annotations to specify ascending or descending sort order. See [`SORT -CASES`](../data/sort-cases.md), for more details on this notation. -Adding `(A)` or `(D)` to the `BY` subcommand specification is a PSPP +CASES`](sort-cases.md), for more details on this notation. Adding +`(A)` or `(D)` to the `BY` subcommand specification is a PSPP extension. The `DROP` subcommand can be used to specify a list of variables to diff --git a/rust/doc/src/commands/utilities/comment.md b/rust/doc/src/commands/comment.md similarity index 100% rename from rust/doc/src/commands/utilities/comment.md rename to rust/doc/src/commands/comment.md diff --git a/rust/doc/src/commands/data/compute.md b/rust/doc/src/commands/compute.md similarity index 77% rename from rust/doc/src/commands/data/compute.md rename to rust/doc/src/commands/compute.md index 11ecabcbb8..a7128fbee9 100644 --- a/rust/doc/src/commands/data/compute.md +++ b/rust/doc/src/commands/compute.md @@ -20,23 +20,20 @@ output format. String variables must be declared before they can be used as targets for `COMPUTE`. The target variable may be specified as an element of a -[vector](../../commands/variables/vector.md). In this case, an -expression `INDEX` must be specified in parentheses following the vector -name. The expression `INDEX` must evaluate to a numeric value that, -after rounding down to the nearest integer, is a valid index for the -named vector. +[vector](vector.md). In this case, an expression `INDEX` must be +specified in parentheses following the vector name. The expression +`INDEX` must evaluate to a numeric value that, after rounding down to +the nearest integer, is a valid index for the named vector. Using `COMPUTE` to assign to a variable specified on -[`LEAVE`](../../commands/variables/leave.md) resets the variable's -left state. Therefore, `LEAVE` should be specified following -`COMPUTE`, not before. +[`LEAVE`](leave.md) resets the variable's left state. Therefore, +`LEAVE` should be specified following `COMPUTE`, not before. `COMPUTE` is a transformation. It does not cause the active dataset to be read. -When `COMPUTE` is specified following -[`TEMPORARY`](../selection/temporary.md), the -[`LAG`](../../language/expressions/functions/miscellaneous.md) +When `COMPUTE` is specified following [`TEMPORARY`](temporary.md), the +[`LAG`](../language/expressions/functions/miscellaneous.md) function may not be used. ## Example @@ -65,13 +62,12 @@ descriptives /weight height bmi. This syntax shows how you can use `COMPUTE` to generate a new variable called bmi and have every case's value calculated from the existing values of weight and height. It also shows how you can [add a -label](../../commands/variables/variable-labels.md) to this new -variable, so that a more descriptive label appears in subsequent -analyses, and this can be seen in the output from the `DESCRIPTIVES` -command, below. +label](variable-labels.md) to this new variable, so that a more +descriptive label appears in subsequent analyses, and this can be seen +in the output from the `DESCRIPTIVES` command, below. The expression which follows the `=` sign can be as complicated as -necessary. See [Expressions](../../language/expressions/index.md) for +necessary. See [Expressions](../language/expressions/index.md) for a full description of the language accepted. ``` diff --git a/rust/doc/src/commands/control/index.md b/rust/doc/src/commands/control.md similarity index 79% rename from rust/doc/src/commands/control/index.md rename to rust/doc/src/commands/control.md index 3b005f993f..c464732071 100644 --- a/rust/doc/src/commands/control/index.md +++ b/rust/doc/src/commands/control.md @@ -1,2 +1,4 @@ +# Conditionals and Loops + This chapter documents PSPP commands used for conditional execution, looping, and flow of control. diff --git a/rust/doc/src/commands/statistics/correlations.md b/rust/doc/src/commands/correlations.md similarity index 100% rename from rust/doc/src/commands/statistics/correlations.md rename to rust/doc/src/commands/correlations.md diff --git a/rust/doc/src/commands/statistics/crosstabs.md b/rust/doc/src/commands/crosstabs.md similarity index 100% rename from rust/doc/src/commands/statistics/crosstabs.md rename to rust/doc/src/commands/crosstabs.md diff --git a/rust/doc/src/commands/statistics/ctables.md b/rust/doc/src/commands/ctables.md similarity index 99% rename from rust/doc/src/commands/statistics/ctables.md rename to rust/doc/src/commands/ctables.md index a8890029bc..b9ccd1af65 100644 --- a/rust/doc/src/commands/statistics/ctables.md +++ b/rust/doc/src/commands/ctables.md @@ -353,9 +353,9 @@ When PSPP reads data from a file in an external format, such as a text file, variables' measurement levels are often unknown. If `CTABLES` runs when a variable has an unknown measurement level, it makes an initial pass through the data to [guess measurement -levels](../../language/datasets/variables.md). Use the [`VARIABLE -LEVEL`](../../commands/variables/variable-level.md) command to set or -change a variable's measurement level. +levels](../language/datasets/variables.md). Use the [`VARIABLE +LEVEL`](variable-level.md) command to set or change a variable's +measurement level. To treat a variable as categorical or scalar only for one use on `CTABLES`, add `[C]` or `[S]`, respectively, after the variable name. @@ -1520,7 +1520,7 @@ controls how variable labels are displayed for the variables listed on `VARIABLES`. The supported values are: * `DEFAULT` - Use the setting from [`SET TVARS`](../utilities/set.md#tvars)). + Use the setting from [`SET TVARS`](set.md#tvars)). * `NAME` Show only a variable name. @@ -1947,11 +1947,10 @@ The previous section provides an example for `PPROPERTIES`. The `WEIGHT` subcommand is optional and must appear before `TABLE`. If it appears, it must name a numeric variable, known as the "effective weight" or "adjustment weight". The effective weight -variable stands in for the dictionary's [weight -variable](../../commands/selection/weight.md), if any, in most -calculations in `CTABLES`. The only exceptions are the `COUNT`, -`TOTALN`, and `VALIDN` summary functions, which use the dictionary -weight instead. +variable stands in for the dictionary's [weight variable](weight.md), +if any, in most calculations in `CTABLES`. The only exceptions are +the `COUNT`, `TOTALN`, and `VALIDN` summary functions, which use the +dictionary weight instead. Weights obtained from the PSPP dictionary are rounded to the nearest integer at the case level. Effective weights are not rounded. diff --git a/rust/doc/src/commands/data-io/index.md b/rust/doc/src/commands/data-io.md similarity index 100% rename from rust/doc/src/commands/data-io/index.md rename to rust/doc/src/commands/data-io.md diff --git a/rust/doc/src/commands/data-io/data-list.md b/rust/doc/src/commands/data-list.md similarity index 89% rename from rust/doc/src/commands/data-io/data-list.md rename to rust/doc/src/commands/data-list.md index 00c30146d5..36d676e8ab 100644 --- a/rust/doc/src/commands/data-io/data-list.md +++ b/rust/doc/src/commands/data-list.md @@ -12,9 +12,9 @@ format. Each form of `DATA LIST` is described in detail below. - See [`GET DATA`](../spss-io/get-data.md) for a command that offers -a few enhancements over DATA LIST and that may be substituted for DATA -LIST in many situations. + See [`GET DATA`](get-data.md) for a command that offers a few +enhancements over DATA LIST and that may be substituted for DATA LIST +in many situations. ## DATA LIST FIXED @@ -38,13 +38,12 @@ keyword `FIXED` is optional. The `FILE` subcommand must be used if input is to be taken from an external file. It may be used to specify a file name as a string or a -[file handle](../../language/files/file-handles.md). If the `FILE` +[file handle](../language/files/file-handles.md). If the `FILE` subcommand is not used, then input is assumed to be specified within the command file using [`BEGIN DATA`...`END DATA`](begin-data.md). The `ENCODING` subcommand may only be used if the `FILE` subcommand is also used. It specifies the character encoding of the file. See -[`INSERT`](../utilities/insert.md), for information on supported -encodings. +[`INSERT`](insert.md), for information on supported encodings. The optional `RECORDS` subcommand, which takes a single integer as an argument, is used to specify the number of lines per record. If @@ -70,7 +69,7 @@ of variable specifications may be present. Each variable specification consists of a list of variable names followed by a description of their location on the input line. [Sets -of variables](../../language/datasets/variable-lists.html) may be with +of variables](../language/datasets/variable-lists.html) may be with `TO`, e.g. `VAR1 TO VAR5`. There are two ways to specify the location of the variable on the line: columnar style and FORTRAN style. @@ -78,8 +77,8 @@ of the variable on the line: columnar style and FORTRAN style. field are specified after the variable name, separated by a dash (`-`). For instance, the third through fifth columns on a line would be specified `3-5`. By default, variables are considered to be in -[`F` format](../../language/datasets/formats/basic.html). (Use [`SET -FORMAT`](../utilities/set.md#format) to change the default.) +[`F` format](../language/datasets/formats/basic.html). (Use [`SET +FORMAT`](set.md#format) to change the default.) In columnar style, to use a variable format other than the default, specify the format type in parentheses after the column numbers. For @@ -110,7 +109,7 @@ into the input line as it uses. specification with `D` decimal places also has `D` implied decimal places. In addition to the [standard - formats](../../language/datasets/formats/index.html), FORTRAN style + formats](../language/datasets/formats/index.html), FORTRAN style defines some extensions: * `X` @@ -220,13 +219,13 @@ where each VAR_SPEC takes one of the forms In free format, the input data is, by default, structured as a series of fields separated by spaces, tabs, or line breaks. If the -current [`DECIMAL`](../utilities/set.md#decimal) separator is `DOT`, -then commas are also treated as field separators. Each field's -content may be unquoted, or it may be quoted with a pairs of -apostrophes (`'`) or double quotes (`"`). Unquoted white space -separates fields but is not part of any field. Any mix of spaces, -tabs, and line breaks is equivalent to a single space for the purpose -of separating fields, but consecutive commas will skip a field. +current [`DECIMAL`](set.md#decimal) separator is `DOT`, then commas +are also treated as field separators. Each field's content may be +unquoted, or it may be quoted with a pairs of apostrophes (`'`) or +double quotes (`"`). Unquoted white space separates fields but is not +part of any field. Any mix of spaces, tabs, and line breaks is +equivalent to a single space for the purpose of separating fields, but +consecutive commas will skip a field. Alternatively, delimiters can be specified explicitly, as a parenthesized, comma-separated list of single-character strings @@ -246,7 +245,7 @@ FIXED` above. The variables to be parsed are given as a single list of variable names. This list must be introduced by a single slash (`/`). The set of variable names may contain [format -specifications](../../language/datasets/formats/index.html) in +specifications](../language/datasets/formats/index.html) in parentheses. Format specifications apply to all variables back to the previous parenthesized format specification. diff --git a/rust/doc/src/commands/data/index.md b/rust/doc/src/commands/data.md similarity index 86% rename from rust/doc/src/commands/data/index.md rename to rust/doc/src/commands/data.md index d4f051786a..cb64195625 100644 --- a/rust/doc/src/commands/data/index.md +++ b/rust/doc/src/commands/data.md @@ -1,2 +1,4 @@ +# Transforming Data + The PSPP procedures in this chapter manipulate data and prepare the active dataset for later analyses. They do not produce output. diff --git a/rust/doc/src/commands/data-io/datafile-attribute.md b/rust/doc/src/commands/datafile-attribute.md similarity index 97% rename from rust/doc/src/commands/data-io/datafile-attribute.md rename to rust/doc/src/commands/datafile-attribute.md index 9fcfb16180..b6c440ce9e 100644 --- a/rust/doc/src/commands/data-io/datafile-attribute.md +++ b/rust/doc/src/commands/datafile-attribute.md @@ -37,7 +37,7 @@ position. To associate custom attributes with particular variables, instead of with the entire active dataset, use [`VARIABLE -ATTRIBUTE`](../variables/variable-attribute.md) instead. +ATTRIBUTE`](variable-attribute.md) instead. `DATAFILE ATTRIBUTE` takes effect immediately. It is not affected by conditional and looping structures such as `DO IF` or `LOOP`. diff --git a/rust/doc/src/commands/data-io/dataset.md b/rust/doc/src/commands/dataset.md similarity index 98% rename from rust/doc/src/commands/data-io/dataset.md rename to rust/doc/src/commands/dataset.md index 1c2c71d0b1..3866a2308b 100644 --- a/rust/doc/src/commands/data-io/dataset.md +++ b/rust/doc/src/commands/dataset.md @@ -35,7 +35,7 @@ active dataset becomes unnamed. initially "empty," that is, it has no dictionary or data. If a dataset with the given name already exists, this has no effect. The new dataset can be used with commands that support output to a -dataset, such as. [`AGGREGATE`](../data/aggregate.md). +dataset, such as. [`AGGREGATE`](aggregate.md). The `DATASET CLOSE` command deletes a dataset. If the active dataset is specified by name, or if `*` is specified, then the active dataset diff --git a/rust/doc/src/commands/control/define.md b/rust/doc/src/commands/define.md similarity index 95% rename from rust/doc/src/commands/control/define.md rename to rust/doc/src/commands/define.md index 2d3764b69f..ed997935b6 100644 --- a/rust/doc/src/commands/control/define.md +++ b/rust/doc/src/commands/define.md @@ -246,7 +246,7 @@ Each argument declaration specifies the form of its value: * `!TOKENS(count)` Exactly `count` tokens, e.g. `!TOKENS(1)` for a single token. Each identifier, number, quoted string, operator, or punctuator is a - token (see [Tokens](../../language/basics/tokens.md) for details). + token (see [Tokens](../language/basics/tokens.md) for details). The following variant of `!analyze_kw` accepts only a single variable name (or `ALL`) as its argument: @@ -324,7 +324,7 @@ declaration suppresses this expansion. Multiple factors control whether macro calls are expanded in different situations. At the highest level, `SET MEXPAND` controls whether macro calls are expanded. By default, it is enabled. [`SET -MEXPAND`](../utilities/set.md#mexpand), for details. +MEXPAND`](set.md#mexpand), for details. A macro body may contain macro calls. By default, these are expanded. If a macro body contains `!OFFEXPAND` or `!ONEXPAND` directives, then @@ -636,7 +636,7 @@ ranges and loops over tokens. Both forms expand a "loop body" multiple times, each time setting a named "loop variable" to a different value. The loop body typically expands the loop variable at least once. -The [`MITERATE` setting](../utilities/set.md#miterate) limits the number of +The [`MITERATE` setting](set.md#miterate) limits the number of iterations in a loop. This is a safety measure to ensure that macro expansion terminates. PSPP issues a warning when the `MITERATE` limit is exceeded. @@ -687,32 +687,31 @@ parentheses. ## Macro Settings -Some macro behavior is controlled through the -[`SET`](../utilities/set.md) command. This section describes these -settings. +the [`SET`](set.md) command controls some macro behavior. This +section describes these settings. Any `SET` command that changes these settings within a macro body only takes effect following the macro. This is because PSPP expands a macro's entire body at once, so that `SET` inside the body only executes afterwards. -The [`MEXPAND`](../utilities/set.md#mexpand) setting controls whether +The [`MEXPAND`](set.md#mexpand) setting controls whether macros will be expanded at all. By default, macro expansion is on. To avoid expansion of macros called within a macro body, use [`!OFFEXPAND` and `!ONEXPAND`](#controlling-macro-expansion). -When [`MPRINT`](../utilities/set.md#mprint) is turned on, PSPP outputs +When [`MPRINT`](set.md#mprint) is turned on, PSPP outputs an expansion of each macro called. This feature can be useful for debugging macro definitions. For reading the expanded version, keep in mind that macro expansion removes comments and standardizes white space. -[`MNEST`](../utilities/set.md#mnest) limits the depth of expansion of +[`MNEST`](set.md#mnest) limits the depth of expansion of macro calls, that is, the nesting level of macro expansion. The default is 50. This is mainly useful to avoid infinite expansion in the case of a macro that calls itself. -[`MITERATE`](../utilities/set.md#miterate) limits the number of +[`MITERATE`](set.md#miterate) limits the number of iterations in a `!DO` construct. The default is 1000. ## Additional Notes @@ -738,8 +737,8 @@ doesn't matter, as long as macro B has been defined when A is called. Macros and command terminators require care. Macros honor the syntax differences between [interactive and batch -syntax](../../language/basics/syntax-variants.md), which means that -the interpretation of a macro can vary depending on the syntax mode in +syntax](../language/basics/syntax-variants.md), which means that the +interpretation of a macro can vary depending on the syntax mode in use. We assume here that interactive mode is in use, in which `.` at the end of a line is the primary way to end a command. @@ -755,19 +754,19 @@ Macro directives such as `!IF` and `!DO` do not end with `.`. PSPP does not expand macros within comments, whether introduced within a line by `/*` or as a separate [`COMMENT` or -`*`](../utilities/comment.md) command. (SPSS does expand macros in +`*`](comment.md) command. (SPSS does expand macros in `COMMENT` and `*`.) Macros do not expand within quoted strings. -Macros are expanded in the [`TITLE`](../utilities/title.md) and -[`SUBTITLE`](../utilities/subtitle.md) commands as long as their +Macros are expanded in the [`TITLE`](title.md) and +[`SUBTITLE`](subtitle.md) commands as long as their arguments are not quoted strings. ### PRESERVE and RESTORE -Some macro bodies might use the [`SET`](../utilities/set.md) command -to change certain settings. When this is the case, consider using the -[`PRESERVE` and `RESTORE`](../utilities/preserve.md) commands to save -and then restore these settings. +Some macro bodies might use the [`SET`](set.md) command to change +certain settings. When this is the case, consider using the +[`PRESERVE` and `RESTORE`](preserve.md) commands to save and then +restore these settings. diff --git a/rust/doc/src/commands/variables/delete-variables.md b/rust/doc/src/commands/delete-variables.md similarity index 85% rename from rust/doc/src/commands/variables/delete-variables.md rename to rust/doc/src/commands/delete-variables.md index 19599d1de0..f466f853fa 100644 --- a/rust/doc/src/commands/variables/delete-variables.md +++ b/rust/doc/src/commands/delete-variables.md @@ -12,6 +12,5 @@ to be read. If it is used while `TEMPORARY` is in effect, it causes the temporary transformations to become permanent. `DELETE VARIABLES` may not be used to delete all variables from the -dictionary; use [`NEW FILE`](../../commands/data-io/new-file.html) -instead. +dictionary; use [`NEW FILE`](new-file.html) instead. diff --git a/rust/doc/src/commands/statistics/descriptives.md b/rust/doc/src/commands/descriptives.md similarity index 98% rename from rust/doc/src/commands/statistics/descriptives.md rename to rust/doc/src/commands/descriptives.md index 3f32cd704b..6585fc73e0 100644 --- a/rust/doc/src/commands/statistics/descriptives.md +++ b/rust/doc/src/commands/descriptives.md @@ -43,8 +43,8 @@ the names `ZSC000` through `ZSC999`, `STDZ00` through `STDZ09`, Z-score variable names may also be specified explicitly on `VARIABLES` in the variable list by enclosing them in parentheses after each variable. When Z scores are calculated, PSPP ignores -[`TEMPORARY`](../../commands/selection/temporary.md), treating -temporary transformations as permanent. +[`TEMPORARY`](temporary.md), treating temporary transformations as +permanent. The `STATISTICS` subcommand specifies the statistics to be displayed: diff --git a/rust/doc/src/commands/utilities/display-documents.md b/rust/doc/src/commands/display-documents.md similarity index 100% rename from rust/doc/src/commands/utilities/display-documents.md rename to rust/doc/src/commands/display-documents.md diff --git a/rust/doc/src/commands/utilities/display-file-label.md b/rust/doc/src/commands/display-file-label.md similarity index 100% rename from rust/doc/src/commands/utilities/display-file-label.md rename to rust/doc/src/commands/display-file-label.md diff --git a/rust/doc/src/commands/variables/display.md b/rust/doc/src/commands/display.md similarity index 89% rename from rust/doc/src/commands/variables/display.md rename to rust/doc/src/commands/display.md index 1b376dc3d1..4c90b867e7 100644 --- a/rust/doc/src/commands/variables/display.md +++ b/rust/doc/src/commands/display.md @@ -44,7 +44,8 @@ keyword causes output to be sorted alphabetically by variable name. * `SCRATCH` Displays Variablen ames, for [scratch - variables](../../language/datasets/scratch-variables.md) only. + variables](../language/datasets/scratch-variables.md) only. + variables](../language/datasets/scratch-variables.md) only. * `ATTRIBUTES` Datafile and variable attributes are displayed, except attributes @@ -59,7 +60,6 @@ vectors. If the `SORTED` keyword is given, the vectors are listed in alphabetical order; otherwise, they are listed in textual order of definition within the PSPP syntax file. -For related commands, see [`DISPLAY -DOCUMENTS`](../utilities/display-documents.md) and [`DISPLAY FILE -LABEL`](../utilities/display-file-label.md). +For related commands, see [`DISPLAY DOCUMENTS`](display-documents.md) +and [`DISPLAY FILE LABEL`](display-file-label.md). diff --git a/rust/doc/src/commands/control/do-if.md b/rust/doc/src/commands/do-if.md similarity index 82% rename from rust/doc/src/commands/control/do-if.md rename to rust/doc/src/commands/do-if.md index a4a36ebe63..3f8569764c 100644 --- a/rust/doc/src/commands/control/do-if.md +++ b/rust/doc/src/commands/do-if.md @@ -22,7 +22,7 @@ turn, with the same rules applied. If all expressions evaluate to false, then the `ELSE` code block is executed, if it is present. When `DO IF` or `ELSE IF` is specified following -[`TEMPORARY`](../../commands/selection/temporary.md), the -[`LAG`](../../language/expressions/functions/miscellaneous.md) -function may not be used. +[`TEMPORARY`](temporary.md), the +[`LAG`](../language/expressions/functions/miscellaneous.md) function +may not be used. diff --git a/rust/doc/src/commands/control/do-repeat.md b/rust/doc/src/commands/do-repeat.md similarity index 100% rename from rust/doc/src/commands/control/do-repeat.md rename to rust/doc/src/commands/do-repeat.md diff --git a/rust/doc/src/commands/utilities/document.md b/rust/doc/src/commands/document.md similarity index 100% rename from rust/doc/src/commands/utilities/document.md rename to rust/doc/src/commands/document.md diff --git a/rust/doc/src/commands/utilities/drop-documents.md b/rust/doc/src/commands/drop-documents.md similarity index 100% rename from rust/doc/src/commands/utilities/drop-documents.md rename to rust/doc/src/commands/drop-documents.md diff --git a/rust/doc/src/commands/utilities/echo.md b/rust/doc/src/commands/echo.md similarity index 61% rename from rust/doc/src/commands/utilities/echo.md rename to rust/doc/src/commands/echo.md index d868940d4e..6a1bedce6d 100644 --- a/rust/doc/src/commands/utilities/echo.md +++ b/rust/doc/src/commands/echo.md @@ -6,5 +6,6 @@ ECHO 'arbitrary text' . Use `ECHO` to write arbitrary text to the output stream. The text should be enclosed in quotation marks following the normal rules for -[string tokens](../../language/basics/tokens.md#strings). +[string tokens](../language/basics/tokens.md#strings). +[string tokens](../language/basics/tokens.md#strings). diff --git a/rust/doc/src/commands/data-io/end-case.md b/rust/doc/src/commands/end-case.md similarity index 100% rename from rust/doc/src/commands/data-io/end-case.md rename to rust/doc/src/commands/end-case.md diff --git a/rust/doc/src/commands/data-io/end-file.md b/rust/doc/src/commands/end-file.md similarity index 100% rename from rust/doc/src/commands/data-io/end-file.md rename to rust/doc/src/commands/end-file.md diff --git a/rust/doc/src/commands/utilities/erase.md b/rust/doc/src/commands/erase.md similarity index 75% rename from rust/doc/src/commands/utilities/erase.md rename to rust/doc/src/commands/erase.md index 42b65f6f23..36e7607a35 100644 --- a/rust/doc/src/commands/utilities/erase.md +++ b/rust/doc/src/commands/erase.md @@ -6,5 +6,5 @@ ERASE FILE "FILE_NAME". `ERASE FILE` deletes a file from the local file system. The file's name must be quoted. This command cannot be used if the -[`SAFER`](../utilities/set.md#safer) setting is active. +[`SAFER`](set.md#safer) setting is active. diff --git a/rust/doc/src/commands/statistics/examine.md b/rust/doc/src/commands/examine.md similarity index 100% rename from rust/doc/src/commands/statistics/examine.md rename to rust/doc/src/commands/examine.md diff --git a/rust/doc/src/commands/utilities/execute.md b/rust/doc/src/commands/execute.md similarity index 100% rename from rust/doc/src/commands/utilities/execute.md rename to rust/doc/src/commands/execute.md diff --git a/rust/doc/src/commands/spss-io/export.md b/rust/doc/src/commands/export.md similarity index 92% rename from rust/doc/src/commands/spss-io/export.md rename to rust/doc/src/commands/export.md index 0ac99994d0..a704a059a1 100644 --- a/rust/doc/src/commands/spss-io/export.md +++ b/rust/doc/src/commands/export.md @@ -16,7 +16,7 @@ EXPORT data to a specified portable file. `UNSELECTED` controls whether cases excluded with -[`FILTER`](../selection/filter.md) are written to the file. These can +[`FILTER`](filter.md) are written to the file. These can be excluded by specifying `DELETE` on the `UNSELECTED` subcommand. The default is `RETAIN`. @@ -31,7 +31,7 @@ precision to write. `DIGITS` applies only to non-integers. The `OUTFILE` subcommand, which is the only required subcommand, specifies the portable file to be written as a file name string or a -[file handle](../../language/files/file-handles.md). +[file handle](../language/files/file-handles.md). `DROP`, `KEEP`, and `RENAME` have the same syntax and meaning as for the [`SAVE`](save.md) command. diff --git a/rust/doc/src/commands/statistics/factor.md b/rust/doc/src/commands/factor.md similarity index 92% rename from rust/doc/src/commands/statistics/factor.md rename to rust/doc/src/commands/factor.md index e1577c2178..760b1ffca2 100644 --- a/rust/doc/src/commands/statistics/factor.md +++ b/rust/doc/src/commands/factor.md @@ -38,13 +38,13 @@ variables that participate; it is useful primarily in conjunction with If `MATRIX IN` instead of `VARIABLES` is specified, then the analysis is performed on a pre-prepared correlation or covariance matrix file instead of on individual data cases. Typically the [matrix -file](../matrix/index.md#matrix-files) will have been generated by -[`MATRIX DATA`](../matrix/matrix-data.md) or provided by a third -party. If specified, `MATRIX IN` must be followed by `COV` or `CORR`, -then by `=` and `FILE_SPEC` all in parentheses. `FILE_SPEC` may -either be an asterisk, which indicates the currently loaded dataset, -or it may be a file name to be loaded. See [`MATRIX -DATA`](../matrix/matrix-data.md), for the expected format of the file. +file](matrices.md#matrix-files) will have been generated by [`MATRIX +DATA`](matrix-data.md) or provided by a third party. If specified, +`MATRIX IN` must be followed by `COV` or `CORR`, then by `=` and +`FILE_SPEC` all in parentheses. `FILE_SPEC` may either be an +asterisk, which indicates the currently loaded dataset, or it may be a +file name to be loaded. See [`MATRIX DATA`](matrix-data.md), for the +expected format of the file. The `/EXTRACTION` subcommand is used to specify the way in which factors (components) are extracted from the data. If `PC` is specified, diff --git a/rust/doc/src/commands/data-io/file-handle.md b/rust/doc/src/commands/file-handle.md similarity index 95% rename from rust/doc/src/commands/data-io/file-handle.md rename to rust/doc/src/commands/file-handle.md index 72ebe282e4..878e71cb33 100644 --- a/rust/doc/src/commands/data-io/file-handle.md +++ b/rust/doc/src/commands/file-handle.md @@ -176,9 +176,9 @@ use is forbidden. The `ENCODING` subcommand specifies the encoding of text in the file. For reading text files in `CHARACTER` mode, all of the forms -described for `ENCODING` on the [`INSERT`](../utilities/insert.md) -command are supported. For reading in other file-based modes, -encoding autodetection is not supported; if the specified encoding -requests autodetection then the default encoding is used. This is -also true when a file handle is used for writing a file in any mode. +described for `ENCODING` on the [`INSERT`](insert.md) command are +supported. For reading in other file-based modes, encoding +autodetection is not supported; if the specified encoding requests +autodetection then the default encoding is used. This is also true +when a file handle is used for writing a file in any mode. diff --git a/rust/doc/src/commands/utilities/file-label.md b/rust/doc/src/commands/file-label.md similarity index 100% rename from rust/doc/src/commands/utilities/file-label.md rename to rust/doc/src/commands/file-label.md diff --git a/rust/doc/src/commands/selection/filter.md b/rust/doc/src/commands/filter.md similarity index 100% rename from rust/doc/src/commands/selection/filter.md rename to rust/doc/src/commands/filter.md diff --git a/rust/doc/src/commands/utilities/finish.md b/rust/doc/src/commands/finish.md similarity index 100% rename from rust/doc/src/commands/utilities/finish.md rename to rust/doc/src/commands/finish.md diff --git a/rust/doc/src/commands/data/flip.md b/rust/doc/src/commands/flip.md similarity index 95% rename from rust/doc/src/commands/data/flip.md rename to rust/doc/src/commands/flip.md index 42e0767830..083de6f063 100644 --- a/rust/doc/src/commands/data/flip.md +++ b/rust/doc/src/commands/flip.md @@ -37,14 +37,14 @@ characters are truncated. If `FLIP` is called again on this dataset, the `CASE_LBL` variable can be passed to the `NEWNAMES` subcommand to recreate the original variable names. -`FLIP` honors [`N OF CASES`](../selection/n.md). It ignores -[`TEMPORARY`](../selection/temporary.md), so that "temporary" +`FLIP` honors [`N OF CASES`](n.md). It ignores +[`TEMPORARY`](temporary.md), so that "temporary" transformations become permanent. ## Example In the syntax below, data has been entered using [`DATA -LIST`](../../commands/data-io/data-list.md) such that the first +LIST`](data-list.md) such that the first variable in the dataset is a string variable containing a description of the other data for the case. Clearly this is not a convenient arrangement for performing statistical analyses, so it would have been @@ -76,9 +76,8 @@ As you can see in the results below, before the `FLIP` command has run there are seven variables (six containing data and one for the heading) and three cases. Afterwards there are four variables (one per case, plus the CASE_LBL variable) and six cases. You can delete -the CASE_LBL variable (see [DELETE -VARIABLES](../../commands/variables/delete-variables.md)) if you don't -need it. +the CASE_LBL variable (see [DELETE VARIABLES](delete-variables.md)) if +you don't need it. ``` Before FLIP: diff --git a/rust/doc/src/commands/variables/formats.md b/rust/doc/src/commands/formats.md similarity index 86% rename from rust/doc/src/commands/variables/formats.md rename to rust/doc/src/commands/formats.md index 6efaca255d..9c0e669d36 100644 --- a/rust/doc/src/commands/variables/formats.md +++ b/rust/doc/src/commands/formats.md @@ -6,7 +6,8 @@ FORMATS VAR_LIST (FMT_SPEC) [VAR_LIST (FMT_SPEC)].... `FORMATS` set both print and write formats for the specified variables to the specified [output -format](../../language/datasets/formats/index.md). +format](../language/datasets/formats/index.md). +format](../language/datasets/formats/index.md). Specify a list of variables followed by a format specification in parentheses. The print and write formats of the specified variables diff --git a/rust/doc/src/commands/statistics/frequencies.md b/rust/doc/src/commands/frequencies.md similarity index 100% rename from rust/doc/src/commands/statistics/frequencies.md rename to rust/doc/src/commands/frequencies.md diff --git a/rust/doc/src/commands/spss-io/get-data.md b/rust/doc/src/commands/get-data.md similarity index 95% rename from rust/doc/src/commands/spss-io/get-data.md rename to rust/doc/src/commands/get-data.md index 3845839f6a..ccbb47b72a 100644 --- a/rust/doc/src/commands/spss-io/get-data.md +++ b/rust/doc/src/commands/get-data.md @@ -151,15 +151,15 @@ GET DATA /TYPE=TXT When `TYPE=TXT` is specified, `GET DATA` reads data in a delimited or fixed columnar format, much like [`DATA -LIST`](../../commands/data-io/data-list.md). +LIST`](data-list.md). The `FILE` subcommand must specify the file to be read as a string file name or (for textual data only) a [file -handle](../../language/files/file-handles.md)). +handle](../language/files/file-handles.md)). The `ENCODING` subcommand specifies the character encoding of the -file to be read. See [`INSERT`](../utilities/insert.md), for -information on supported encodings. +file to be read. See [`INSERT`](insert.md), for information on +supported encodings. The `ARRANGEMENT` subcommand determines the file's basic format. `DELIMITED`, the default setting, specifies that fields in the input data @@ -173,9 +173,8 @@ first line. To skip lines at the beginning of an input file, set first line, 3 to skip the first two lines, and so on. `IMPORTCASES` is ignored, for compatibility. Use [`N OF -CASES`](../selection/n.md) to limit the number of cases read from a -file, or [`SAMPLE`](../selection/sample.md) to obtain a random sample -of cases. +CASES`](n.md) to limit the number of cases read from a file, or +[`SAMPLE`](sample.md) to obtain a random sample of cases. The remaining subcommands apply only to one of the two file arrangements, described below. @@ -200,9 +199,8 @@ where each DEL_VAR takes the form: The `GET DATA` command with `TYPE=TXT` and `ARRANGEMENT=DELIMITED` reads input data from text files in delimited format, where fields are separated by a set of user-specified delimiters. Its capabilities are -similar to those of [`DATA LIST -FREE`](../../commands/data-io/data-list.md#data-list-free), with a few -enhancements. +similar to those of [`DATA LIST FREE`](data-list.md#data-list-free), +with a few enhancements. The required `FILE` subcommand and optional `FIRSTCASE` and `IMPORTCASE` subcommands are described [above](#textual-data-files). @@ -243,7 +241,7 @@ n_variables`, where `n_variables` is the number of variables per case. The `VARIABLES` subcommand is required and must be the last subcommand. Specify the name of each variable and its [input -format](../../language/datasets/formats/index.md), in the order they +format](../language/datasets/formats/index.md), in the order they should be read from the input file. #### Example 1 @@ -342,8 +340,7 @@ where each FIXED_VAR takes the form: reads input data from text files in fixed format, where each field is located in particular fixed column positions within records of a case. Its capabilities are similar to those of [`DATA LIST -FIXED`](../../commands/data-io/data-list.md#data-list-fixed), with a -few enhancements. +FIXED`](data-list.md#data-list-fixed), with a few enhancements. The required `FILE` subcommand and optional `FIRSTCASE` and `IMPORTCASE` subcommands are described [above](#textual-data-files). diff --git a/rust/doc/src/commands/spss-io/get.md b/rust/doc/src/commands/get.md similarity index 96% rename from rust/doc/src/commands/spss-io/get.md rename to rust/doc/src/commands/get.md index 3777bcc54e..299c8b444c 100644 --- a/rust/doc/src/commands/spss-io/get.md +++ b/rust/doc/src/commands/get.md @@ -15,7 +15,8 @@ them with the dictionary and data from a specified file. The `FILE` subcommand is the only required subcommand. Specify the SPSS system file, SPSS/PC+ system file, or SPSS portable file to be read as a string file name or a [file -handle](../../language/files/file-handles.md). +handle](../language/files/file-handles.md). +handle](../language/files/file-handles.md). By default, all the variables in a file are read. The `DROP` subcommand can be used to specify a list of variables that are not to diff --git a/rust/doc/src/commands/statistics/glm.md b/rust/doc/src/commands/glm.md similarity index 100% rename from rust/doc/src/commands/statistics/glm.md rename to rust/doc/src/commands/glm.md diff --git a/rust/doc/src/commands/statistics/graph.md b/rust/doc/src/commands/graph.md similarity index 100% rename from rust/doc/src/commands/statistics/graph.md rename to rust/doc/src/commands/graph.md diff --git a/rust/doc/src/commands/utilities/host.md b/rust/doc/src/commands/host.md similarity index 94% rename from rust/doc/src/commands/utilities/host.md rename to rust/doc/src/commands/host.md index 1fcb7d0911..1503713877 100644 --- a/rust/doc/src/commands/utilities/host.md +++ b/rust/doc/src/commands/host.md @@ -29,8 +29,8 @@ the execution time to the specified number of seconds. PSPP built for mingw does not support all the features of `HOST`. -PSPP rejects this command if the [`SAFER`](../utilities/set.md#safer) -setting is active. +PSPP rejects this command if the [`SAFER`](set.md#safer) setting is +active. ## Example diff --git a/rust/doc/src/commands/data/if.md b/rust/doc/src/commands/if.md similarity index 67% rename from rust/doc/src/commands/data/if.md rename to rust/doc/src/commands/if.md index b56fb60c56..08a45a316a 100644 --- a/rust/doc/src/commands/data/if.md +++ b/rust/doc/src/commands/if.md @@ -10,7 +10,8 @@ The `IF` transformation evaluates a test expression and, if it is true, assigns the value of a target expression to a target variable. Specify a boolean-valued test -[expression](../../language/expressions/index.md) to be tested following the +[expression](../language/expressions/index.md) to be tested following the +[expression](../language/expressions/index.md) to be tested following the `IF` keyword. The test expression is evaluated for each case: - If it is true, then the target expression is evaluated and assigned @@ -24,17 +25,17 @@ string result is truncated or padded with spaces on the right as necessary. The expression and variable types must match. The target variable may be specified as an element of a -[vector](../../commands/variables/vector.md). In this case, a vector +[vector](vector.md). In this case, a vector index expression must be specified in parentheses following the vector name. The index expression must evaluate to a numeric value that, after rounding down to the nearest integer, is a valid index for the named vector. -Using `IF` to assign to a variable specified on -[`LEAVE`](../../commands/variables/leave.md) resets the variable's -left state. Therefore, use `LEAVE` after `IF`, not before. +Using `IF` to assign to a variable specified on [`LEAVE`](leave.md) +resets the variable's left state. Therefore, use `LEAVE` after `IF`, +not before. -When `IF` follows [`TEMPORARY`](../selection/temporary.md), the -[`LAG`](../../language/expressions/functions/miscellaneous.md) function may not -be used. +When `IF` follows [`TEMPORARY`](temporary.md), the +[`LAG`](../language/expressions/functions/miscellaneous.md) function +may not be used. diff --git a/rust/doc/src/commands/spss-io/import.md b/rust/doc/src/commands/import.md similarity index 88% rename from rust/doc/src/commands/spss-io/import.md rename to rust/doc/src/commands/import.md index 60365f45ee..c183f2cdfb 100644 --- a/rust/doc/src/commands/spss-io/import.md +++ b/rust/doc/src/commands/import.md @@ -15,7 +15,8 @@ portable file. The `FILE` subcommand, which is the only required subcommand, specifies the portable file to be read as a file name string or a -[file handle](../../language/files/file-handles.md). +[file handle](../language/files/file-handles.md). +[file handle](../language/files/file-handles.md). The `TYPE` subcommand is currently not used. diff --git a/rust/doc/src/commands/utilities/include.md b/rust/doc/src/commands/include.md similarity index 100% rename from rust/doc/src/commands/utilities/include.md rename to rust/doc/src/commands/include.md diff --git a/rust/doc/src/commands/data-io/input-program.md b/rust/doc/src/commands/input-program.md similarity index 96% rename from rust/doc/src/commands/data-io/input-program.md rename to rust/doc/src/commands/input-program.md index 9c3a2d66be..7fb093e724 100644 --- a/rust/doc/src/commands/data-io/input-program.md +++ b/rust/doc/src/commands/input-program.md @@ -24,7 +24,8 @@ stop when end of file is reached on any of the data files. To prevent `INPUT PROGRAM` from terminating at the first end of file, use the `END` subcommand on `DATA LIST`. This subcommand takes a variable name, which should be a numeric [scratch -variable](../../language/datasets/scratch-variables.md). (It need not +variable](../language/datasets/scratch-variables.md). (It need not +variable](../language/datasets/scratch-variables.md). (It need not be a scratch variable but otherwise the results can be surprising.) The value of this variable is set to 0 when reading the data file, or 1 when end of file is encountered. diff --git a/rust/doc/src/commands/utilities/insert.md b/rust/doc/src/commands/insert.md similarity index 89% rename from rust/doc/src/commands/utilities/insert.md rename to rust/doc/src/commands/insert.md index 8f3efdc7a8..26b01ee986 100644 --- a/rust/doc/src/commands/utilities/insert.md +++ b/rust/doc/src/commands/insert.md @@ -25,7 +25,8 @@ at the next command. The default setting is `ERROR=CONTINUE`. If `SYNTAX=INTERACTIVE` is specified then the syntax contained in the included file must conform to [interactive syntax -conventions](../../language/basics/syntax-variants.md). The default +conventions](../language/basics/syntax-variants.md). The default +conventions](../language/basics/syntax-variants.md). The default setting is `SYNTAX=BATCH`. `ENCODING` optionally specifies the character set used by the @@ -34,9 +35,9 @@ one of the following forms: * `LOCALE` The encoding used by the system locale, or as overridden by [`SET - LOCALE`](../utilities/set.md#locale). On GNU/Linux and other - Unix-like systems, environment variables, e.g. `LANG` or `LC_ALL`, - determine the system locale. + LOCALE`](set.md#locale). On GNU/Linux and other Unix-like systems, + environment variables, e.g. `LANG` or `LC_ALL`, determine the system + locale. * `'CHARSET_NAME'` An [IANA character set diff --git a/rust/doc/src/commands/variables/leave.md b/rust/doc/src/commands/leave.md similarity index 100% rename from rust/doc/src/commands/variables/leave.md rename to rust/doc/src/commands/leave.md diff --git a/rust/doc/src/commands/data-io/list.md b/rust/doc/src/commands/list.md similarity index 100% rename from rust/doc/src/commands/data-io/list.md rename to rust/doc/src/commands/list.md diff --git a/rust/doc/src/commands/statistics/logistic-regression.md b/rust/doc/src/commands/logistic-regression.md similarity index 100% rename from rust/doc/src/commands/statistics/logistic-regression.md rename to rust/doc/src/commands/logistic-regression.md diff --git a/rust/doc/src/commands/control/loop.md b/rust/doc/src/commands/loop.md similarity index 84% rename from rust/doc/src/commands/control/loop.md rename to rust/doc/src/commands/loop.md index 0f9b390f14..7632fdc3f6 100644 --- a/rust/doc/src/commands/control/loop.md +++ b/rust/doc/src/commands/loop.md @@ -12,7 +12,8 @@ are offered. Specify `INDEX_VAR` to make that variable count from one value to another by a particular increment. `INDEX_VAR` must be a pre-existing numeric variable. `START`, `END`, and `INCR` are numeric -[expressions](../../language/expressions/index.md). +[expressions](../language/expressions/index.md). +[expressions](../language/expressions/index.md). During the first iteration, `INDEX_VAR` is set to the value of `START`. During each successive iteration, `INDEX_VAR` is increased @@ -45,7 +46,7 @@ not at the beginning, so that the body of a loop with only a condition on `END LOOP` will always execute at least once. If the index clause is not present, then the global -[`MXLOOPS`](../utilities/set.md#mxloops) setting, which defaults to +[`MXLOOPS`](set.md#mxloops) setting, which defaults to 40, limits the number of iterations. [`BREAK`](break.md) also terminates `LOOP` execution. @@ -53,13 +54,12 @@ If the index clause is not present, then the global Loop index variables are by default reset to system-missing from one case to another, not left, unless a scratch variable is used as index. When loops are nested, this is usually undesired behavior, which can -be corrected with [`LEAVE`](../../commands/variables/leave.md) or by -using a [scratch -variable](../../language/datasets/scratch-variables.md) as the loop +be corrected with [`LEAVE`](leave.md) or by using a [scratch +variable](../language/datasets/scratch-variables.md) as the loop index. When `LOOP` or `END LOOP` is specified following -[`TEMPORARY`](../../commands/selection/temporary.md), the -[`LAG`](../../language/expressions/functions/miscellaneous.md) -function may not be used. +[`TEMPORARY`](temporary.md), the +[`LAG`](../language/expressions/functions/miscellaneous.md) function +may not be used. diff --git a/rust/doc/src/commands/combining/match-files.md b/rust/doc/src/commands/match-files.md similarity index 97% rename from rust/doc/src/commands/combining/match-files.md rename to rust/doc/src/commands/match-files.md index fa20c0a1c0..de5a2f19f0 100644 --- a/rust/doc/src/commands/combining/match-files.md +++ b/rust/doc/src/commands/match-files.md @@ -23,7 +23,7 @@ files into single cases in the output, combining their data. `MATCH FILES` shares the bulk of its syntax with other PSPP commands for combining multiple data files (see [Common -Syntax](index.md#common-syntax) for details). +Syntax](combining.md#common-syntax) for details). How `MATCH FILES` matches up cases from the input files depends on whether `BY` is specified: diff --git a/rust/doc/src/commands/matrix/index.md b/rust/doc/src/commands/matrices.md similarity index 97% rename from rust/doc/src/commands/matrix/index.md rename to rust/doc/src/commands/matrices.md index f4d938043b..9c9c46a24e 100644 --- a/rust/doc/src/commands/matrix/index.md +++ b/rust/doc/src/commands/matrices.md @@ -22,8 +22,7 @@ A matrix file's dictionary must have the following variables in the specified order: 1. Zero or more numeric split variables. These are included by - procedures when [`SPLIT - FILE`](../../commands/selection/split-file.md) is active. [`MATRIX + procedures when [`SPLIT FILE`](split-file.md) is active. [`MATRIX DATA`](matrix-data.md) assigns split variables format `F4.0`. 2. `ROWTYPE_`, a string variable with width 8. This variable diff --git a/rust/doc/src/commands/matrix/matrix-data.md b/rust/doc/src/commands/matrix-data.md similarity index 95% rename from rust/doc/src/commands/matrix/matrix-data.md rename to rust/doc/src/commands/matrix-data.md index bbe5f3b4db..b9683fa9b7 100644 --- a/rust/doc/src/commands/matrix/matrix-data.md +++ b/rust/doc/src/commands/matrix-data.md @@ -20,12 +20,12 @@ specified on the VARIABLES subcommand: ``` The `MATRIX DATA` command convert matrices and vectors from text -format into the [matrix file format](index.md#matrix-files) for use by -procedures that read matrices. It reads a text file or inline data and -outputs to the active file, replacing any data already in the active -dataset. The matrix file may then be used by other commands directly -from the active file, or it may be written to a `.sav` file using the -`SAVE` command. +format into the [matrix file format](matrices.md#matrix-files) for use +by procedures that read matrices. It reads a text file or inline data +and outputs to the active file, replacing any data already in the +active dataset. The matrix file may then be used by other commands +directly from the active file, or it may be written to a `.sav` file +using the `SAVE` command. The text data read by `MATRIX DATA` can be delimited by spaces or commas. A plus or minus sign, except immediately following a `d` or @@ -33,13 +33,12 @@ commas. A plus or minus sign, except immediately following a `d` or single or double quotes. `MATRIX DATA` can read the types of matrix and vector data supported -in matrix files (see [Row Types](index.md#row-types)). +in matrix files (see [Row Types](matrices.md#row-types)). The `FILE` subcommand specifies the source of the command's input. To read input from a text file, specify its name in quotes. To supply input inline, omit `FILE` or specify `INLINE`. Inline data must -directly follow `MATRIX DATA`, inside [`BEGIN -DATA`](../../commands/data-io/begin-data.md). +directly follow `MATRIX DATA`, inside [`BEGIN DATA`](begin-data.md). `VARIABLES` is the only required subcommand. It names the variables present in each input record in the order that they appear. (`MATRIX @@ -100,7 +99,7 @@ each case. If `VARIABLES` includes `ROWTYPE_`, each case's `ROWTYPE_` indicates the type of data contained in the row. See [Row -Types](index.md#row-types) for a list of supported row types. +Types](matrices.md#row-types) for a list of supported row types. ### Example 1: Defaults with `ROWTYPE_` diff --git a/rust/doc/src/commands/matrix/matrix.md b/rust/doc/src/commands/matrix.md similarity index 98% rename from rust/doc/src/commands/matrix/matrix.md rename to rust/doc/src/commands/matrix.md index ab6f08b3ff..ff1b65403e 100644 --- a/rust/doc/src/commands/matrix/matrix.md +++ b/rust/doc/src/commands/matrix.md @@ -119,13 +119,12 @@ The matrix language does not support missing values. Macros defined before a matrix program may be used within a matrix program, and macros may expand to include entire matrix programs. The -[`DEFINE`](../../commands/control/define.md) command to define new +[`DEFINE`](define.md) command to define new macros may not appear within a matrix program. The following sections describe the details of the matrix language: first, the syntax of matrix expressions, then each of the supported -commands. The [`COMMENT`](../utilities/comment.md) command is also -supported. +commands. The [`COMMENT`](comment.md) command is also supported. ## Matrix Expressions @@ -661,7 +660,7 @@ like the [elementwise operators](#elementwise-binary-operators). Returns a `NR`×`NC` matrix in which each element is randomly chosen from a uniform distribution of real numbers between 0 and 1. Random number generation honors the current - [seed](../utilities/set.md#seed) setting. + [seed](set.md#seed) setting. The following example shows one possible output, but of course every result will be different (given different seeds): @@ -982,7 +981,7 @@ COMPUTE v(GRADE(-v))=v. /* Sort v in descending order. The matrix language can calculate several functions of standard statistical distributions using the same syntax and semantics as in PSPP transformation expressions. See [Statistical Distribution -Functions](../../language/expressions/functions/statistical-distributions.md) +Functions](../language/expressions/functions/statistical-distributions.md) for details. The matrix language extends the `PDF`, `CDF`, `SIG`, `IDF`, `NPDF`, @@ -1163,7 +1162,7 @@ PRINT [expression] The `PRINT` command is commonly used to display a matrix. It evaluates the restricted EXPRESSION, if present, and outputs it either as text or a pivot table, depending on the setting of -[`MDISPLAY`](../utilities/set.md#mdisplay). +[`MDISPLAY`](set.md#mdisplay). Use the `FORMAT` subcommand to specify a format, such as `F8.2`, for displaying the matrix elements. `FORMAT` is optional for numerical @@ -1311,9 +1310,8 @@ called the loop's "body", repeatedly. It has three optional clauses that control how many times the loop body executes. Regardless of these clauses, the global `MXLOOPS` setting, which defaults to 40, also limits the number of iterations of a loop. To iterate more -times, raise the maximum with [`SET -MXLOOPS`](../utilities/set.md#mxloops) outside of the `MATRIX` -command. +times, raise the maximum with [`SET MXLOOPS`](set.md#mxloops) outside +of the `MATRIX` command. The optional index clause causes VAR to be assigned successive values on each trip through the loop: first `FIRST`, then `FIRST + @@ -1460,9 +1458,8 @@ existing variable. The `FILE` subcommand is required in the first `READ` command that appears within `MATRIX`. It specifies the text file to be read, either as a file name in quotes or a file handle previously declared -on [`FILE HANDLE`](../data-io/file-handle.md). Later `READ` -commands (in syntax order) use the previous referenced file if `FILE` -is omitted. +on [`FILE HANDLE`](file-handle.md). Later `READ` commands (in syntax +order) use the previous referenced file if `FILE` is omitted. The `FIELD` and `FORMAT` subcommands specify how input lines are interpreted. `FIELD` is required, but `FORMAT` is optional. See @@ -1568,9 +1565,8 @@ after the command name. The `OUTFILE` subcommand is required in the first `WRITE` command that appears within `MATRIX`. It specifies the text file to be written, either as a file name in quotes or a file handle previously declared -on [`FILE HANDLE`](../data-io/file-handle.md). Later `WRITE` commands -(in syntax order) use the previous referenced file if `FILE` is -omitted. +on [`FILE HANDLE`](file-handle.md). Later `WRITE` commands (in syntax +order) use the previous referenced file if `FILE` is omitted. The `FIELD` and `FORMAT` subcommands specify how output lines are formed. `FIELD` is required, but `FORMAT` is optional. See [`READ` @@ -1721,7 +1717,7 @@ string columns' variable names on `STRINGS`. MGET [/FILE=file] [/TYPE={COV | CORR | MEAN | STDDEV | N | COUNT}]. ``` -The `MGET` command reads the data from a [matrix file](index.md#matrix-files) into matrix variables. +The `MGET` command reads the data from a [matrix file](matrices.md#matrix-files) into matrix variables. All of `MGET`'s subcommands are optional. Specify the name or handle of the matrix file to be read on the `FILE` subcommand; if it is @@ -1776,7 +1772,7 @@ MSAVE expression [/FNAMES=variable…]. ``` The `MSAVE` command evaluates the expression specified just after the -command name, and writes the resulting matrix to a [matrix file](index.md#matrix-files). +command name, and writes the resulting matrix to a [matrix file](matrices.md#matrix-files). The `TYPE` subcommand is required. It specifies the `ROWTYPE_` to write along with this matrix. diff --git a/rust/doc/src/commands/matrix/mconvert.md b/rust/doc/src/commands/mconvert.md similarity index 100% rename from rust/doc/src/commands/matrix/mconvert.md rename to rust/doc/src/commands/mconvert.md diff --git a/rust/doc/src/commands/statistics/means.md b/rust/doc/src/commands/means.md similarity index 100% rename from rust/doc/src/commands/statistics/means.md rename to rust/doc/src/commands/means.md diff --git a/rust/doc/src/commands/variables/missing-values.md b/rust/doc/src/commands/missing-values.md similarity index 91% rename from rust/doc/src/commands/variables/missing-values.md rename to rust/doc/src/commands/missing-values.md index 8f7e74752f..be07902d6c 100644 --- a/rust/doc/src/commands/variables/missing-values.md +++ b/rust/doc/src/commands/missing-values.md @@ -3,7 +3,8 @@ In many situations, the data available for analysis is incomplete, so that a placeholder must be used to indicate that the value is unknown. One way that missing values are represented, for numeric data, is the -["system-missing value"](../../language/basics/missing-values.html). +["system-missing value"](../language/basics/missing-values.html). +["system-missing value"](../language/basics/missing-values.html). Another, more flexible way is through "user-missing values" which are determined on a per variable basis. diff --git a/rust/doc/src/commands/variables/mrsets.md b/rust/doc/src/commands/mrsets.md similarity index 96% rename from rust/doc/src/commands/variables/mrsets.md rename to rust/doc/src/commands/mrsets.md index 33eb654bf4..477f8ef977 100644 --- a/rust/doc/src/commands/variables/mrsets.md +++ b/rust/doc/src/commands/mrsets.md @@ -36,7 +36,8 @@ and `VALUE` specifications are required. The others are optional: - `NAME` specifies the name used in syntax for the new multiple dichotomy set. The name must begin with `$`; it must otherwise - follow the rules for [identifiers](../../language/basics/tokens.md). + follow the rules for [identifiers](../language/basics/tokens.md). + follow the rules for [identifiers](../language/basics/tokens.md). - `VARIABLES` specifies the variables that belong to the set. At least two variables must be specified. The variables must be all diff --git a/rust/doc/src/commands/selection/n.md b/rust/doc/src/commands/n.md similarity index 100% rename from rust/doc/src/commands/selection/n.md rename to rust/doc/src/commands/n.md diff --git a/rust/doc/src/commands/data-io/new-file.md b/rust/doc/src/commands/new-file.md similarity index 100% rename from rust/doc/src/commands/data-io/new-file.md rename to rust/doc/src/commands/new-file.md diff --git a/rust/doc/src/commands/statistics/npar-tests.md b/rust/doc/src/commands/npar-tests.md similarity index 100% rename from rust/doc/src/commands/statistics/npar-tests.md rename to rust/doc/src/commands/npar-tests.md diff --git a/rust/doc/src/commands/variables/numeric.md b/rust/doc/src/commands/numeric.md similarity index 77% rename from rust/doc/src/commands/variables/numeric.md rename to rust/doc/src/commands/numeric.md index 00a969c23b..66ec124e7e 100644 --- a/rust/doc/src/commands/variables/numeric.md +++ b/rust/doc/src/commands/numeric.md @@ -9,7 +9,8 @@ NUMERIC VAR_LIST [(FMT_SPEC)] [/VAR_LIST [(FMT_SPEC)]]... Specify the names of the new numeric variables as `VAR_LIST`. If you wish to set the variables' output formats, follow their names by -an [output format](../../language/datasets/formats/index.html) in +an [output format](../language/datasets/formats/index.html) in +an [output format](../language/datasets/formats/index.html) in parentheses; otherwise, the default is `F8.2`. Variables created with `NUMERIC` are initialized to the diff --git a/rust/doc/src/commands/statistics/oneway.md b/rust/doc/src/commands/oneway.md similarity index 100% rename from rust/doc/src/commands/statistics/oneway.md rename to rust/doc/src/commands/oneway.md diff --git a/rust/doc/src/commands/utilities/output.md b/rust/doc/src/commands/output.md similarity index 91% rename from rust/doc/src/commands/utilities/output.md rename to rust/doc/src/commands/output.md index 20f53b1df7..e5597bc5d0 100644 --- a/rust/doc/src/commands/utilities/output.md +++ b/rust/doc/src/commands/output.md @@ -38,6 +38,7 @@ For most other numeric values that appear in tables, [`SET FORMAT`](set.md#format)) may be used to specify the format. `FMT_SPEC` must be a valid [output -format](../../language/datasets/formats/index.md). Not all possible +format](../language/datasets/formats/index.md). Not all possible +format](../language/datasets/formats/index.md). Not all possible formats are meaningful for all classes. diff --git a/rust/doc/src/commands/utilities/permissions.md b/rust/doc/src/commands/permissions.md similarity index 72% rename from rust/doc/src/commands/utilities/permissions.md rename to rust/doc/src/commands/permissions.md index 3b0018c4b1..ebf13182a8 100644 --- a/rust/doc/src/commands/utilities/permissions.md +++ b/rust/doc/src/commands/permissions.md @@ -10,8 +10,8 @@ PERMISSIONS mandatory subcommand which specifies the permissions to which the file should be changed. If you set a file's permission to `READONLY`, then the file will become unwritable either by you or anyone else on the -system. If you set the permission to `WRITEABLE`, then the file becomes -writeable by you; the permissions afforded to others are unchanged. -This command cannot be used if the [`SAFER`](../utilities/set.md#safer) setting is -active. +system. If you set the permission to `WRITEABLE`, then the file +becomes writeable by you; the permissions afforded to others are +unchanged. This command cannot be used if the [`SAFER`](set.md#safer) +setting is active. diff --git a/rust/doc/src/commands/utilities/preserve.md b/rust/doc/src/commands/preserve.md similarity index 100% rename from rust/doc/src/commands/utilities/preserve.md rename to rust/doc/src/commands/preserve.md diff --git a/rust/doc/src/commands/data-io/print-eject.md b/rust/doc/src/commands/print-eject.md similarity index 100% rename from rust/doc/src/commands/data-io/print-eject.md rename to rust/doc/src/commands/print-eject.md diff --git a/rust/doc/src/commands/variables/print-formats.md b/rust/doc/src/commands/print-formats.md similarity index 100% rename from rust/doc/src/commands/variables/print-formats.md rename to rust/doc/src/commands/print-formats.md diff --git a/rust/doc/src/commands/data-io/print-space.md b/rust/doc/src/commands/print-space.md similarity index 71% rename from rust/doc/src/commands/data-io/print-space.md rename to rust/doc/src/commands/print-space.md index 06434b5d5f..dc6d5135ff 100644 --- a/rust/doc/src/commands/data-io/print-space.md +++ b/rust/doc/src/commands/print-space.md @@ -8,16 +8,17 @@ PRINT SPACE [OUTFILE='file_name'] [ENCODING='ENCODING'] [n_lines]. The `OUTFILE` subcommand is optional. It may be used to direct output to a file specified by file name as a string or [file -handle](../../language/files/file-handles.md). If `OUTFILE` is not +handle](../language/files/file-handles.md). If `OUTFILE` is not +handle](../language/files/file-handles.md). If `OUTFILE` is not specified then output is directed to the listing file. The `ENCODING` subcommand may only be used if `OUTFILE` is also used. It specifies the character encoding of the file. See -[`INSERT`](../utilities/insert.md), for information on supported +[`INSERT`](insert.md), for information on supported encodings. `n_lines` is also optional. If present, it is an -[expression](../../language/expressions/index.md) for the number of +[expression](../language/expressions/index.md) for the number of blank lines to be printed. The expression must evaluate to a nonnegative value. diff --git a/rust/doc/src/commands/data-io/print.md b/rust/doc/src/commands/print.md similarity index 92% rename from rust/doc/src/commands/data-io/print.md rename to rust/doc/src/commands/print.md index 8fea40363e..c76db79555 100644 --- a/rust/doc/src/commands/data-io/print.md +++ b/rust/doc/src/commands/print.md @@ -18,7 +18,7 @@ ARG takes one of the following forms: The `PRINT` transformation writes variable data to the listing file or an output file. `PRINT` is executed when a procedure causes the data to be read. Follow `PRINT` by -[`EXECUTE`](../utilities/execute.md) to print variable data without +[`EXECUTE`](execute.md) to print variable data without invoking a procedure. All `PRINT` subcommands are optional. If no strings or variables are @@ -26,7 +26,7 @@ specified, `PRINT` outputs a single blank line. The `OUTFILE` subcommand specifies the file to receive the output. The file may be a file name as a string or a [file -handle](../../language/files/file-handles.md). If `OUTFILE` is not +handle](../language/files/file-handles.md). If `OUTFILE` is not present then output is sent to PSPP's output listing file. When `OUTFILE` is present, the output is written to the file in a plain text format, with a space inserted at beginning of each output line, @@ -34,8 +34,8 @@ even lines that otherwise would be blank. The `ENCODING` subcommand may only be used if the `OUTFILE` subcommand is also used. It specifies the character encoding of the -file. See [INSERT](../utilities/insert.md), for information on -supported encodings. +file. See [INSERT](insert.md), for information on supported +encodings. The `RECORDS` subcommand specifies the number of lines to be output. The number of lines may optionally be surrounded by parentheses. diff --git a/rust/doc/src/commands/statistics/quick-cluster.md b/rust/doc/src/commands/quick-cluster.md similarity index 100% rename from rust/doc/src/commands/statistics/quick-cluster.md rename to rust/doc/src/commands/quick-cluster.md diff --git a/rust/doc/src/commands/statistics/rank.md b/rust/doc/src/commands/rank.md similarity index 100% rename from rust/doc/src/commands/statistics/rank.md rename to rust/doc/src/commands/rank.md diff --git a/rust/doc/src/commands/data/recode.md b/rust/doc/src/commands/recode.md similarity index 100% rename from rust/doc/src/commands/data/recode.md rename to rust/doc/src/commands/recode.md diff --git a/rust/doc/src/commands/statistics/regression.md b/rust/doc/src/commands/regression.md similarity index 100% rename from rust/doc/src/commands/statistics/regression.md rename to rust/doc/src/commands/regression.md diff --git a/rust/doc/src/commands/statistics/reliability.md b/rust/doc/src/commands/reliability.md similarity index 95% rename from rust/doc/src/commands/statistics/reliability.md rename to rust/doc/src/commands/reliability.md index 56c2668f0b..bed4b1ef70 100644 --- a/rust/doc/src/commands/statistics/reliability.md +++ b/rust/doc/src/commands/reliability.md @@ -49,9 +49,8 @@ preprocessed. An examination of the survey questions reveals that two questions, viz: v3 and v5 are negatively worded, whereas the others are positively worded. All questions must be based upon the same scale for the analysis to be meaningful. One could use the -[`RECODE`](../../commands/data/recode.md) command, however a simpler -way is to use [`COMPUTE`](../../commands/data/compute.md) and this is what -is done in the syntax below. +[`RECODE`](recode.md) command, however a simpler way is to use +[`COMPUTE`](compute.md) and this is what is done in the syntax below. ``` get file="hotel.sav". diff --git a/rust/doc/src/commands/variables/rename-variables.md b/rust/doc/src/commands/rename-variables.md similarity index 94% rename from rust/doc/src/commands/variables/rename-variables.md rename to rust/doc/src/commands/rename-variables.md index cc0dfc9438..52a05c53e0 100644 --- a/rust/doc/src/commands/variables/rename-variables.md +++ b/rust/doc/src/commands/rename-variables.md @@ -18,5 +18,5 @@ parentheses are optional. data to be read. `RENAME VARIABLES` may not be specified following -[`TEMPORARY`](../selection/temporary.md). +[`TEMPORARY`](temporary.md). diff --git a/rust/doc/src/commands/data-io/repeating-data.md b/rust/doc/src/commands/repeating-data.md similarity index 93% rename from rust/doc/src/commands/data-io/repeating-data.md rename to rust/doc/src/commands/repeating-data.md index 02ca4eb40b..45c232f4f6 100644 --- a/rust/doc/src/commands/data-io/repeating-data.md +++ b/rust/doc/src/commands/repeating-data.md @@ -45,7 +45,8 @@ as with [`DATA LIST FIXED`](data-list.md#data-list-fixed). All other subcommands are optional. `FILE` specifies the file to read, either a file name as a string or a -[file handle](../../language/files/file-handles.md). If `FILE` is not +[file handle](../language/files/file-handles.md). If `FILE` is not +[file handle](../language/files/file-handles.md). If `FILE` is not present then the default is the last file handle used on the most recent `DATA LIST` command. @@ -75,5 +76,5 @@ been declared with `NUMERIC` or another command. `REPEATING DATA` should be the last command given within an [`INPUT PROGRAM`](input-program.md). It should not be enclosed within -[`LOOP`…`END LOOP`](../control/loop.md). Use `DATA LIST` before, not -after, [`REPEATING DATA`](../data-io/repeating-data.md). +[`LOOP`…`END LOOP`](loop.md). Use `DATA LIST` before, not after, +[`REPEATING DATA`](repeating-data.md). diff --git a/rust/doc/src/commands/data-io/reread.md b/rust/doc/src/commands/reread.md similarity index 75% rename from rust/doc/src/commands/data-io/reread.md rename to rust/doc/src/commands/reread.md index 7ff3cd7507..d65ab72b8a 100644 --- a/rust/doc/src/commands/data-io/reread.md +++ b/rust/doc/src/commands/reread.md @@ -10,21 +10,22 @@ re-read for further processing. The `FILE` subcommand, which is optional, is used to specify the file to have its line re-read. The file must be specified as the name of a -[file handle](../../language/files/file-handles.md). If `FILE` is not +[file handle](../language/files/file-handles.md). If `FILE` is not +[file handle](../language/files/file-handles.md). If `FILE` is not specified then the file specified on the most recent `DATA LIST` command is assumed. By default, the line re-read is re-read in its entirety. With the `COLUMN` subcommand, a prefix of the line can be exempted from re-reading. Specify an -[expression](../../language/expressions/index.md) evaluating to the +[expression](../language/expressions/index.md) evaluating to the +[expression](../language/expressions/index.md) evaluating to the first column that should be included in the re-read line. Columns are numbered from 1 at the left margin. The `ENCODING` subcommand may only be used if the `FILE` subcommand is also used. It specifies the character encoding of the file. See -[`INSERT`](../utilities/insert.md) for information on supported -encodings. +[`INSERT`](insert.md) for information on supported encodings. Issuing `REREAD` multiple times will not back up in the data file. Instead, it will re-read the same line multiple times. diff --git a/rust/doc/src/commands/statistics/roc.md b/rust/doc/src/commands/roc.md similarity index 100% rename from rust/doc/src/commands/statistics/roc.md rename to rust/doc/src/commands/roc.md diff --git a/rust/doc/src/commands/selection/sample.md b/rust/doc/src/commands/sample.md similarity index 100% rename from rust/doc/src/commands/selection/sample.md rename to rust/doc/src/commands/sample.md diff --git a/rust/doc/src/commands/spss-io/save-data-collection.md b/rust/doc/src/commands/save-data-collection.md similarity index 92% rename from rust/doc/src/commands/spss-io/save-data-collection.md rename to rust/doc/src/commands/save-data-collection.md index 02d1b9ff5c..c837698c57 100644 --- a/rust/doc/src/commands/spss-io/save-data-collection.md +++ b/rust/doc/src/commands/save-data-collection.md @@ -20,7 +20,8 @@ an additional XML metadata file. `OUTFILE` is required. Specify the system file to be written as a string file name or a [file -handle](../../language/files/file-handles.md). +handle](../language/files/file-handles.md). +handle](../language/files/file-handles.md). `METADATA` is also required. Specify the metadata file to be written as a string file name or a file handle. Metadata files customarily use diff --git a/rust/doc/src/commands/spss-io/save-translate.md b/rust/doc/src/commands/save-translate.md similarity index 95% rename from rust/doc/src/commands/spss-io/save-translate.md rename to rust/doc/src/commands/save-translate.md index d7337817e1..2cf5b03308 100644 --- a/rust/doc/src/commands/spss-io/save-translate.md +++ b/rust/doc/src/commands/save-translate.md @@ -21,7 +21,8 @@ formats understood by other applications. The `OUTFILE` and `TYPE` subcommands are mandatory. `OUTFILE` specifies the file to be written, as a string file name or a [file -handle](../../language/files/file-handles.md). `TYPE` determines the +handle](../language/files/file-handles.md). `TYPE` determines the +handle](../language/files/file-handles.md). `TYPE` determines the type of the file or source to read. It must be one of the following: * `CSV` @@ -95,7 +96,7 @@ written to the output file: numbers. Numeric values use, by default, the decimal point character set with - [`SET DECIMAL`](../utilities/set.md#decimal). Use `DECIMAL=DOT` or + [`SET DECIMAL`](set.md#decimal). Use `DECIMAL=DOT` or `DECIMAL=COMMA` to force a particular decimal point character. * `CELLS=VALUES FORMAT=VARIABLE` @@ -118,7 +119,7 @@ the specified string separate values. If `DELIMITER` is not specified, then the default is a comma with `DECIMAL=DOT` or a semicolon with `DECIMAL=COMMA`. If `DECIMAL` is not given either, it is inferred from the decimal point character set with [`SET -DECIMAL`](../utilities/set.md#decimal). +DECIMAL`](set.md#decimal). The `TEXTOPTIONS QUALIFIER` setting specifies a character that is output before and after a value that contains the delimiter character or diff --git a/rust/doc/src/commands/spss-io/save.md b/rust/doc/src/commands/save.md similarity index 94% rename from rust/doc/src/commands/spss-io/save.md rename to rust/doc/src/commands/save.md index fe872764b1..624f7e2550 100644 --- a/rust/doc/src/commands/spss-io/save.md +++ b/rust/doc/src/commands/save.md @@ -19,7 +19,8 @@ dataset to be written to a system file. `OUTFILE` is the only required subcommand. Specify the system file to be written as a string file name or a [file -handle](../../language/files/file-handles.md). +handle](../language/files/file-handles.md). +handle](../language/files/file-handles.md). By default, cases excluded with `FILTER` are written to the system file. These can be excluded by specifying `DELETE` on the `UNSELECTED` @@ -46,8 +47,8 @@ determine the system file's compression level: written with this compression level cannot be read by PSPP 0.8.1 or earlier or by SPSS 20 or earlier. -`COMPRESSED` is the default compression level. The -[`SET`](../utilities/set.md) command can change this default. +`COMPRESSED` is the default compression level. The [`SET`](set.md) +command can change this default. The `PERMISSIONS` subcommand specifies operating system permissions for the new system file. `WRITEABLE`, the default, creates the file diff --git a/rust/doc/src/commands/selection/select-if.md b/rust/doc/src/commands/select-if.md similarity index 93% rename from rust/doc/src/commands/selection/select-if.md rename to rust/doc/src/commands/select-if.md index 259cc912a8..5660874714 100644 --- a/rust/doc/src/commands/selection/select-if.md +++ b/rust/doc/src/commands/select-if.md @@ -9,7 +9,8 @@ EXPRESSION. Cases not selected are permanently eliminated from the active dataset, unless [`TEMPORARY`](temporary.md) is in effect. Specify a [boolean -expression](../../language/expressions/index.md#boolean-values). If +expression](../language/expressions/index.md#boolean-values). If +expression](../language/expressions/index.md#boolean-values). If the expression is true for a particular case, the case is analyzed. If the expression is false or missing, then the case is deleted from the data stream. @@ -21,7 +22,8 @@ cannot be re-instated. If you want to be able to re-instate cases, then use [`FILTER`](filter.md) instead. When `SELECT IF` is specified following [`TEMPORARY`](temporary.md), -the [`LAG`](../../language/expressions/functions/miscellaneous.md) +the [`LAG`](../language/expressions/functions/miscellaneous.md) +the [`LAG`](../language/expressions/functions/miscellaneous.md) function may not be used. ## Example diff --git a/rust/doc/src/commands/selection/index.md b/rust/doc/src/commands/selection.md similarity index 100% rename from rust/doc/src/commands/selection/index.md rename to rust/doc/src/commands/selection.md diff --git a/rust/doc/src/commands/utilities/set.md b/rust/doc/src/commands/set.md similarity index 86% rename from rust/doc/src/commands/utilities/set.md rename to rust/doc/src/commands/set.md index 9f747591f4..0814ba8942 100644 --- a/rust/doc/src/commands/utilities/set.md +++ b/rust/doc/src/commands/set.md @@ -95,18 +95,18 @@ files. The data input subcommands are character to be `,`. Setting it to `COMMA` causes the decimal point character to be `,` and the grouping character to be `.`. If the setting is `COMMA`, then `,` is not treated as a field separator in - the [`DATA LIST`](../data-io/data-list.md) command. The default + the [`DATA LIST`](data-list.md) command. The default value is determined from the system locale. * `FORMAT` Changes the default numeric [input/output - format](../../language/datasets/formats/index.md). The default is + format](../language/datasets/formats/index.md). The default is initially `F8.2`. * `EPOCH` Specifies the range of years used when a 2-digit year is read from a data file or used in a [date construction - expression](../../language/expressions/functions/time-and-date.md#constructing-dates). + expression](../language/expressions/functions/time-and-date.md#constructing-dates). If a 4-digit year is specified for the epoch, then 2-digit years are interpreted starting from that year, known as the epoch. If `AUTOMATIC` (the default) is specified, then the epoch begins 69 @@ -115,7 +115,7 @@ files. The data input subcommands are * `RIB` PSPP extension to set the byte ordering (endianness) used for reading data in [`IB` or `PIB` - format](../../language/datasets/formats/binary-and-hex.md#ib-and-pib-formats). In + format](../language/datasets/formats/binary-and-hex.md#ib-and-pib-formats). In `MSBFIRST` ordering, the most-significant byte appears at the left end of a IB or PIB field. In `LSBFIRST` ordering, the least-significant byte appears at the left end. `NATIVE`, the @@ -152,10 +152,9 @@ execute. The syntax execution subcommands are * `MXLOOPS` The maximum number of iterations for an uncontrolled - [`LOOP`](../../commands/control/loop.md), and for any [loop in the - matrix - language](../../commands/matrix/matrix.md#the-loop-and-break-commands). - The default `MXLOOPS` is 40. + [`LOOP`](loop.md), and for any [loop in the matrix + language](matrix.md#the-loop-and-break-commands). The default + `MXLOOPS` is 40. * `SEED` The initial pseudo-random number seed. Set it to a real number or @@ -168,13 +167,13 @@ execute. The syntax execution subcommands are The maximum number of bits of errors in the least-significant places to accept for rounding up a value that is almost halfway between two possibilities for rounding with the - [RND](../../language/expressions/functions/mathematical.md#rnd). The default - FUZZBITS is 6. + [RND](../language/expressions/functions/mathematical.md#rnd). The + default FUZZBITS is 6. * `SCALEMIN` The minimum number of distinct valid values for PSPP to assume that a variable has a scale [measurement - level](../../language/datasets/variables.md#measurement-level). + level](../language/datasets/variables.md#measurement-level). * `WORKSPACE` The maximum amount of memory (in kilobytes) that PSPP uses to store @@ -194,7 +193,7 @@ subcommands are `CCD` `CCE` Set up [custom currency - formats](../../language/datasets/formats/custom-currency.md). + formats](../language/datasets/formats/custom-currency.md). * `DECIMAL` The default `DOT` setting causes the decimal point character to be @@ -203,7 +202,7 @@ subcommands are * `FORMAT` Allows the default numeric [input/output - format](../../language/datasets/formats/index.md) to be specified. The + format](../language/datasets/formats/index.md) to be specified. The default is `F8.2`. * `LEADZERO` @@ -214,12 +213,10 @@ subcommands are only the `F`, `COMMA`, and `DOT` formats. * `MDISPLAY` - Controls how the - [`PRINT`](../../commands/matrix/matrix.md#the-print-command) command - within [`MATRIX`...`END MATRIX`](../../commands/matrix/matrix.md) - outputs matrices. With the default `TEXT`, `PRINT` outputs matrices - as text. Change this setting to `TABLES` to instead output matrices - as pivot tables. + Controls how the [`PRINT`](matrix.md#the-print-command) command + within [`MATRIX`...`END MATRIX`](matrix.md) outputs matrices. With + the default `TEXT`, `PRINT` outputs matrices as text. Change this + setting to `TABLES` to instead output matrices as pivot tables. * `SMALL` This controls how PSPP formats small numbers in pivot tables, in @@ -232,7 +229,7 @@ subcommands are * `WIB` PSPP extension to set the byte ordering (endianness) used for writing data in [`IB` or `PIB` - format](../../language/datasets/formats/binary-and-hex.md#ib-and-pib-formats). + format](../language/datasets/formats/binary-and-hex.md#ib-and-pib-formats). In `MSBFIRST` ordering, the most-significant byte appears at the left end of a IB or PIB field. In `LSBFIRST` ordering, the least-significant byte appears at the left end. `NATIVE`, the @@ -294,22 +291,20 @@ These subcommands are: displayed with their literal value (which for a numeric value is a number and for a string value an alphanumeric string). If `TNUMBERS` is set to `LABELS`, then values are displayed using their - assigned [value labels](../../commands/variables/value-labels.md), if - any. If the value has no label, then the literal value is used for - display. If `TNUMBERS` is set to `BOTH`, then values are displayed - with both their label (if any) and their literal value in - parentheses. + assigned [value labels](value-labels.md), if any. If the value has + no label, then the literal value is used for display. If `TNUMBERS` + is set to `BOTH`, then values are displayed with both their label + (if any) and their literal value in parentheses. * `TVARS` The `TVARS` option sets the way in which variables are displayed in output tables. The valid settings are `NAMES`, `LABELS` and `BOTH`. If `TVARS` is set to `NAMES`, then all variables are displayed using their names. If `TVARS` is set to `LABELS`, then variables are - displayed using their [variable - label](../../commands/variables/variable-labels.md), if one has been - set. If no label has been set, then the name is used. If `TVARS` - is set to `BOTH`, then variables are displayed with both their label - (if any) and their name in parentheses. + displayed using their [variable label](variable-labels.md), if one + has been set. If no label has been set, then the name is used. If + `TVARS` is set to `BOTH`, then variables are displayed with both + their label (if any) and their name in parentheses. * `TLOOK` The `TLOOK` option sets the style used for subsequent table output. @@ -383,8 +378,7 @@ to perform. The security subcommands are the system's locale. The following subcommands affect the interpretation of macros. For -more information, see [Macro -Settings](../control/define.md#macro-settings). +more information, see [Macro Settings](define.md#macro-settings). * `MEXPAND` Controls whether macros are expanded. The default is `ON`. @@ -396,10 +390,10 @@ Settings](../control/define.md#macro-settings). * `MITERATE` Limits the number of iterations executed in - [`!DO`](../../commands/control/define.md#macro-loops) loops within - macros. This does not affect other language constructs such as - [`LOOP`…`END LOOP`](../../commands/control/loop.md). This must be set to a - positive integer. The default is 1000. + [`!DO`](define.md#macro-loops) loops within macros. This does not + affect other language constructs such as [`LOOP`…`END + LOOP`](loop.md). This must be set to a positive integer. The + default is 1000. * `MNEST` Limits the number of levels of nested macro expansions. This must diff --git a/rust/doc/src/commands/utilities/show.md b/rust/doc/src/commands/show.md similarity index 95% rename from rust/doc/src/commands/utilities/show.md rename to rust/doc/src/commands/show.md index c74c39ce89..0fb0c8a3c5 100644 --- a/rust/doc/src/commands/utilities/show.md +++ b/rust/doc/src/commands/show.md @@ -62,7 +62,7 @@ additional subcommands: * `WARRANTY` Show details of the lack of warranty for PSPP. * `COPYING` or `LICENSE` - Display the terms of [PSPP's copyright licence](../../license.md). + Display the terms of [PSPP's copyright licence](../license.md). Specifying `SHOW` without any subcommands is equivalent to `SHOW ALL`. diff --git a/rust/doc/src/commands/data/sort-cases.md b/rust/doc/src/commands/sort-cases.md similarity index 98% rename from rust/doc/src/commands/data/sort-cases.md rename to rust/doc/src/commands/sort-cases.md index 58761335fb..9c3dbaf924 100644 --- a/rust/doc/src/commands/data/sort-cases.md +++ b/rust/doc/src/commands/sort-cases.md @@ -95,5 +95,4 @@ order. `SORT CASES` affects only the active file. It does not have any effect upon the `physiology.sav` file itself. For that, you would -have to rewrite the file using the [`SAVE`](../spss-io/save.md) -command. +have to rewrite the file using the [`SAVE`](save.md) command. diff --git a/rust/doc/src/commands/variables/sort-variables.md b/rust/doc/src/commands/sort-variables.md similarity index 100% rename from rust/doc/src/commands/variables/sort-variables.md rename to rust/doc/src/commands/sort-variables.md diff --git a/rust/doc/src/commands/selection/split-file.md b/rust/doc/src/commands/split-file.md similarity index 93% rename from rust/doc/src/commands/selection/split-file.md rename to rust/doc/src/commands/split-file.md index 66f4741c88..680ebc842b 100644 --- a/rust/doc/src/commands/selection/split-file.md +++ b/rust/doc/src/commands/split-file.md @@ -23,7 +23,7 @@ distinction. Groups are formed only by _adjacent_ cases. To create a split using a variable where like values are not adjacent in the working file, first -[sort the data](../../commands/data/sort-cases.md) by that variable. +[sort the data](sort-cases.md) by that variable. Specify `OFF` to disable `SPLIT FILE` and resume analysis of the entire active dataset as a single group of data. @@ -36,12 +36,11 @@ affects only the next procedure. The file `horticulture.sav` contains data describing the yield of a number of horticultural specimens which have been subjected to various treatments. If we wanted to investigate linear statistics of the -yeild, one way to do this is using -[`DESCRIPTIVES`](../statistics/descriptives.md). However, it is -reasonable to expect the mean to be different depending on the -treatment. So we might want to perform three separate procedures -- -one for each treatment.[^1] The following syntax shows how this can be -done automatically using the `SPLIT FILE` command. +yeild, one way to do this is using [`DESCRIPTIVES`](descriptives.md). +However, it is reasonable to expect the mean to be different depending +on the treatment. So we might want to perform three separate +procedures -- one for each treatment.[^1] The following syntax shows +how this can be done automatically using the `SPLIT FILE` command. [^1]: There are other, possibly better, ways to achieve a similar result using the `MEANS` or `EXAMINE` commands. diff --git a/rust/doc/src/commands/spss-io/index.md b/rust/doc/src/commands/spss-io.md similarity index 100% rename from rust/doc/src/commands/spss-io/index.md rename to rust/doc/src/commands/spss-io.md diff --git a/rust/doc/src/commands/statistics/index.md b/rust/doc/src/commands/statistics.md similarity index 83% rename from rust/doc/src/commands/statistics/index.md rename to rust/doc/src/commands/statistics.md index 026e79fc93..e5af974ad4 100644 --- a/rust/doc/src/commands/statistics/index.md +++ b/rust/doc/src/commands/statistics.md @@ -1 +1,3 @@ +# Statistics + This chapter documents the statistical procedures that PSPP supports. diff --git a/rust/doc/src/commands/variables/string.md b/rust/doc/src/commands/string.md similarity index 88% rename from rust/doc/src/commands/variables/string.md rename to rust/doc/src/commands/string.md index c8c9e3d1d9..189fd66629 100644 --- a/rust/doc/src/commands/variables/string.md +++ b/rust/doc/src/commands/string.md @@ -8,7 +8,8 @@ STRING VAR_LIST (FMT_SPEC) [/VAR_LIST (FMT_SPEC)] [...]. Specify a list of names for the variable you want to create, followed by the desired [output -format](../../language/datasets/formats/index.html) in parentheses. +format](../language/datasets/formats/index.html) in parentheses. +format](../language/datasets/formats/index.html) in parentheses. Variable widths are implicitly derived from the specified output formats. The created variables will be initialized to spaces. diff --git a/rust/doc/src/commands/utilities/subtitle.md b/rust/doc/src/commands/subtitle.md similarity index 100% rename from rust/doc/src/commands/utilities/subtitle.md rename to rust/doc/src/commands/subtitle.md diff --git a/rust/doc/src/commands/spss-io/sysfile-info.md b/rust/doc/src/commands/sysfile-info.md similarity index 100% rename from rust/doc/src/commands/spss-io/sysfile-info.md rename to rust/doc/src/commands/sysfile-info.md diff --git a/rust/doc/src/commands/statistics/t-test.md b/rust/doc/src/commands/t-test.md similarity index 100% rename from rust/doc/src/commands/statistics/t-test.md rename to rust/doc/src/commands/t-test.md diff --git a/rust/doc/src/commands/selection/temporary.md b/rust/doc/src/commands/temporary.md similarity index 100% rename from rust/doc/src/commands/selection/temporary.md rename to rust/doc/src/commands/temporary.md diff --git a/rust/doc/src/commands/utilities/title.md b/rust/doc/src/commands/title.md similarity index 100% rename from rust/doc/src/commands/utilities/title.md rename to rust/doc/src/commands/title.md diff --git a/rust/doc/src/commands/combining/update.md b/rust/doc/src/commands/update.md similarity index 97% rename from rust/doc/src/commands/combining/update.md rename to rust/doc/src/commands/update.md index 7b50bccd6d..5916027bfc 100644 --- a/rust/doc/src/commands/combining/update.md +++ b/rust/doc/src/commands/update.md @@ -21,7 +21,7 @@ or more "transaction files". `UPDATE` shares the bulk of its syntax with other PSPP commands for combining multiple data files (see [Common -Syntax](index.md#common-syntax) for details). +Syntax](combining.md#common-syntax) for details). At least two `FILE` subcommands must be specified. The first `FILE` subcommand names the master file, and the rest name transaction files. diff --git a/rust/doc/src/commands/utilities/index.md b/rust/doc/src/commands/utilities.md similarity index 100% rename from rust/doc/src/commands/utilities/index.md rename to rust/doc/src/commands/utilities.md diff --git a/rust/doc/src/commands/variables/value-labels.md b/rust/doc/src/commands/value-labels.md similarity index 100% rename from rust/doc/src/commands/variables/value-labels.md rename to rust/doc/src/commands/value-labels.md diff --git a/rust/doc/src/commands/variables/variable-alignment.md b/rust/doc/src/commands/variable-alignment.md similarity index 100% rename from rust/doc/src/commands/variables/variable-alignment.md rename to rust/doc/src/commands/variable-alignment.md diff --git a/rust/doc/src/commands/variables/variable-attribute.md b/rust/doc/src/commands/variable-attribute.md similarity index 92% rename from rust/doc/src/commands/variables/variable-attribute.md rename to rust/doc/src/commands/variable-attribute.md index 2a8eb269a7..38fe06cbfd 100644 --- a/rust/doc/src/commands/variables/variable-attribute.md +++ b/rust/doc/src/commands/variable-attribute.md @@ -20,7 +20,8 @@ should apply. Use the `ATTRIBUTE` subcommand to add or modify custom variable attributes. Specify the name of the attribute as an -[identifier](../../language/basics/tokens.md), followed by the desired +[identifier](../language/basics/tokens.md), followed by the desired +[identifier](../language/basics/tokens.md), followed by the desired value, in parentheses, as a quoted string. The specified attributes are then added or modified in the variables specified on `VARIABLES`. Attribute names that begin with `$` are reserved for PSPP's internal @@ -44,7 +45,7 @@ deleted element are shifted down, filling the vacated position. To associate custom attributes with the entire active dataset, instead of with particular variables, use [`DATAFILE -ATTRIBUTE`](../../commands/data-io/datafile-attribute.md) instead. +ATTRIBUTE`](datafile-attribute.md) instead. `VARIABLE ATTRIBUTE` takes effect immediately. It is not affected by conditional and looping structures such as `DO IF` or `LOOP`. diff --git a/rust/doc/src/commands/variables/variable-labels.md b/rust/doc/src/commands/variable-labels.md similarity index 100% rename from rust/doc/src/commands/variables/variable-labels.md rename to rust/doc/src/commands/variable-labels.md diff --git a/rust/doc/src/commands/variable-level.md b/rust/doc/src/commands/variable-level.md new file mode 100644 index 0000000000..1517e021c0 --- /dev/null +++ b/rust/doc/src/commands/variable-level.md @@ -0,0 +1,10 @@ +# VARIABLE LEVEL + +``` +VARIABLE LEVEL variables ({SCALE | NOMINAL | ORDINAL})... +``` + +`VARIABLE LEVEL` sets the [measurement +level](../language/datasets/variables.md) of the listed variables. +level](../language/datasets/variables.md) of the listed variables. + diff --git a/rust/doc/src/commands/variables/variable-role.md b/rust/doc/src/commands/variable-role.md similarity index 100% rename from rust/doc/src/commands/variables/variable-role.md rename to rust/doc/src/commands/variable-role.md diff --git a/rust/doc/src/commands/variables/variable-width.md b/rust/doc/src/commands/variable-width.md similarity index 100% rename from rust/doc/src/commands/variables/variable-width.md rename to rust/doc/src/commands/variable-width.md diff --git a/rust/doc/src/commands/variables/index.md b/rust/doc/src/commands/variables.md similarity index 71% rename from rust/doc/src/commands/variables/index.md rename to rust/doc/src/commands/variables.md index 1dc0d73b5c..13f12c65cb 100644 --- a/rust/doc/src/commands/variables/index.md +++ b/rust/doc/src/commands/variables.md @@ -1,7 +1,8 @@ # Manipulating Variables Every value in a dataset is associated with a -[variable](../../language/datasets/variables.md). Variables describe +[variable](../language/datasets/variables.md). Variables describe +[variable](../language/datasets/variables.md). Variables describe what the values represent and properties of those values, such as the format in which they should be displayed, whether they are numeric or alphabetic and how missing values should be represented. There are diff --git a/rust/doc/src/commands/variables/variable-level.md b/rust/doc/src/commands/variables/variable-level.md deleted file mode 100644 index 029c5de02f..0000000000 --- a/rust/doc/src/commands/variables/variable-level.md +++ /dev/null @@ -1,9 +0,0 @@ -# VARIABLE LEVEL - -``` -VARIABLE LEVEL variables ({SCALE | NOMINAL | ORDINAL})... -``` - -`VARIABLE LEVEL` sets the [measurement -level](../../language/datasets/variables.md) of the listed variables. - diff --git a/rust/doc/src/commands/variables/vector.md b/rust/doc/src/commands/vector.md similarity index 92% rename from rust/doc/src/commands/variables/vector.md rename to rust/doc/src/commands/vector.md index 2dad3971d3..58a2905a67 100644 --- a/rust/doc/src/commands/variables/vector.md +++ b/rust/doc/src/commands/vector.md @@ -28,7 +28,8 @@ exist prior to `VECTOR`. Vectors created with `VECTOR` disappear after any procedure or procedure-like command is executed. The variables contained in the vectors remain, unless they are [scratch -variables](../../language/datasets/scratch-variables.md). +variables](../language/datasets/scratch-variables.md). +variables](../language/datasets/scratch-variables.md). Variables within a vector may be referenced in expressions using `vector(index)` syntax. diff --git a/rust/doc/src/commands/selection/weight.md b/rust/doc/src/commands/weight.md similarity index 96% rename from rust/doc/src/commands/selection/weight.md rename to rust/doc/src/commands/weight.md index 7f4532178d..a4d218edcd 100644 --- a/rust/doc/src/commands/selection/weight.md +++ b/rust/doc/src/commands/weight.md @@ -13,7 +13,8 @@ If a variable name is specified, `WEIGHT` causes the values of that variable to be used as weighting factors for subsequent statistical procedures. Use of keyword `BY` is optional but recommended. Weighting variables must be numeric. [Scratch -variables](../../language/datasets/scratch-variables.md) may not be +variables](../language/datasets/scratch-variables.md) may not be +variables](../language/datasets/scratch-variables.md) may not be used for weighting. When `OFF` is specified, subsequent statistical procedures weight all @@ -60,7 +61,7 @@ frequencies /variables = item /format=dfreq. One analysis which most surely would be of interest is the relative amounts or each item in stock. However without setting a weight -variable, [`FREQUENCIES`](../statistics/frequencies.md) does not tell +variable, [`FREQUENCIES`](frequencies.md) does not tell us what we want to know, since there is only one case for each stock item. The output below shows the difference between the weighted and unweighted frequency tables. diff --git a/rust/doc/src/commands/variables/write-formats.md b/rust/doc/src/commands/write-formats.md similarity index 100% rename from rust/doc/src/commands/variables/write-formats.md rename to rust/doc/src/commands/write-formats.md diff --git a/rust/doc/src/commands/data-io/write.md b/rust/doc/src/commands/write.md similarity index 100% rename from rust/doc/src/commands/data-io/write.md rename to rust/doc/src/commands/write.md diff --git a/rust/doc/src/commands/spss-io/xexport.md b/rust/doc/src/commands/xexport.md similarity index 100% rename from rust/doc/src/commands/spss-io/xexport.md rename to rust/doc/src/commands/xexport.md diff --git a/rust/doc/src/commands/spss-io/xsave.md b/rust/doc/src/commands/xsave.md similarity index 100% rename from rust/doc/src/commands/spss-io/xsave.md rename to rust/doc/src/commands/xsave.md diff --git a/rust/doc/src/data/aggregate.md b/rust/doc/src/data/aggregate.md index f2a9a54f95..2ce4518670 100644 --- a/rust/doc/src/data/aggregate.md +++ b/rust/doc/src/data/aggregate.md @@ -50,10 +50,10 @@ If the active dataset is already sorted or grouped by the break variables, specify `PRESORTED` to save time. With `MODE=ADDVARIABLES`, the data must be pre-sorted. -Specify `DOCUMENT` to copy the [documents](../utilities/document.md) -from the active dataset into the aggregate file. Otherwise, the -aggregate file does not contain any documents, even if the aggregate -file replaces the active dataset. +Specify `DOCUMENT` to copy the [documents](document.md) from the +active dataset into the aggregate file. Otherwise, the aggregate file +does not contain any documents, even if the aggregate file replaces +the active dataset. Normally, `AGGREGATE` produces a non-missing value whenever there is enough non-missing data for the aggregation function in use, that is, @@ -144,8 +144,8 @@ variables: * `N(VAR_NAME...)` `NMISS(VAR_NAME...)` Total weight of non-missing or missing values, respectively. The - default format is `F7.0` if weighting is not enabled, `F8.2` if it is - (see [`WEIGHT`](../selection/weight.md)). + default format is `F7.0` if weighting is not enabled, `F8.2` if it + is (see [`WEIGHT`](weight.md)). * `NU(VAR_NAME...)` `NUMISS(VAR_NAME...)` @@ -165,7 +165,7 @@ These aggregation functions do not accept source variables: * `N` Total weight of cases aggregated to form this group. The default format is `F7.0` if weighting is not enabled, `F8.2` if it is (see - [`WEIGHT`](../selection/weight.md)). + [`WEIGHT`](weight.md)). * `NU` Count of cases aggregated to form this group, ignoring case @@ -181,7 +181,7 @@ specifying such a function as the last token on a line causes the period to be interpreted as the end of the command.) `AGGREGATE` both ignores and cancels the current [`SPLIT -FILE`](../selection/split-file.md) settings. +FILE`](split-file.md) settings. ## Aggregate Example diff --git a/rust/doc/src/invoking/pspp-show.md b/rust/doc/src/invoking/pspp-show.md index f162a4b4ef..2356eca2be 100644 --- a/rust/doc/src/invoking/pspp-show.md +++ b/rust/doc/src/invoking/pspp-show.md @@ -21,8 +21,8 @@ The following ``s are available: `--data`, also outputs cases from the system file. This can be useful as an alternative to PSPP syntax commands such as - [`SYSFILE INFO`](../commands/spss-io/sysfile-info.md) or [`DISPLAY - DICTIONARY`](../commands/variables/display.md). + [`SYSFILE INFO`](../commands/sysfile-info.md) or [`DISPLAY + DICTIONARY`](../commands/display.md). [`pspp convert`](pspp-convert.md) is a better way to convert a system file to another format. diff --git a/rust/doc/src/language/datasets/formats/basic.md b/rust/doc/src/language/datasets/formats/basic.md index 0c9d95ac4c..6f9aa47dbc 100644 --- a/rust/doc/src/language/datasets/formats/basic.md +++ b/rust/doc/src/language/datasets/formats/basic.md @@ -21,7 +21,7 @@ output some variation on this style: - Numbers in `COMMA` format are additionally grouped every three digits by inserting a grouping character. The grouping character is ordinarily a comma, but it can be changed to a period (with [`SET - DECIMAL`](../../../commands/utilities/set.md#decimal)). + DECIMAL`](../../../commands/set.md#decimal)). - `DOT` format is like `COMMA` format, but it interchanges the role of the decimal point and grouping characters. That is, the current @@ -45,7 +45,7 @@ lowercase), or by a letter followed by a sign. A single space may follow the letter or the sign or both. On [fixed-format `DATA -LIST`](../../../commands/data-io/data-list.md#data-list-fixed) and in +LIST`](../../../commands/data-list.md#data-list-fixed) and in a few other contexts, decimals are implied when the field does not contain a decimal point. In `F6.5` format, for example, the field `314159` is taken as the value 3.14159 with implied decimals. @@ -126,7 +126,7 @@ More details of basic numeric output formatting are given below: output is 0, and a decimal point is included, then PSPP ordinarily drops the zero before the decimal point. However, in `F`, `COMMA`, or `DOT` formats, PSPP keeps the zero if [`SET - LEADZERO`](../../../commands/utilities/set.md#leadzero) is set to + LEADZERO`](../../../commands/set.md#leadzero) is set to `ON`. In scientific notation, the number always includes a decimal point, diff --git a/rust/doc/src/language/datasets/formats/binary-and-hex.md b/rust/doc/src/language/datasets/formats/binary-and-hex.md index 16e5b07566..e0a7ef250a 100644 --- a/rust/doc/src/language/datasets/formats/binary-and-hex.md +++ b/rust/doc/src/language/datasets/formats/binary-and-hex.md @@ -12,7 +12,7 @@ Thus, data in binary formats should not be included in syntax files or read from data files with variable-length records, such as ordinary text files. They may be read from or written to data files with fixed-length records. See [`FILE -HANDLE`](../../../commands/data-io/file-handle.md), for information on +HANDLE`](../../../commands/file-handle.md), for information on working with fixed-length records. ## `P` and `PK` Formats @@ -43,9 +43,9 @@ were requested). These are integer binary formats. `IB` reads and writes 2's complement binary integers, and `PIB` reads and writes unsigned binary integers. The byte ordering is by default the host machine's, but -[`SET RIB`](../../../commands/utilities/set.md#rib) may be used to -select a specific byte ordering for reading and [`SET -WIB`](../../../commands/utilities/set.md#wib), similarly, for writing. +[`SET RIB`](../../../commands/set.md#rib) may be used to select a +specific byte ordering for reading and [`SET +WIB`](../../../commands/set.md#wib), similarly, for writing. The maximum field width is 8. Decimal places may range from 0 up to the number of decimal digits in the largest value representable in the @@ -59,10 +59,9 @@ field width, plus 1 if the format has decimal places. This is a binary format for real numbers. It reads and writes the host machine's floating-point format. The byte ordering is by default -the host machine's, but [`SET -RIB`](../../../commands/utilities/set.md#rib) may be used to select a -specific byte ordering for reading and [`SET -WIB`](../../../commands/utilities/set.md#wib), similarly, for writing. +the host machine's, but [`SET RIB`](../../../commands/set.md#rib) may +be used to select a specific byte ordering for reading and [`SET +WIB`](../../../commands/set.md#wib), similarly, for writing. The field width should be 4, for 32-bit floating-point numbers, or 8, for 64-bit floating-point numbers. Other field widths do not produce diff --git a/rust/doc/src/language/datasets/formats/index.md b/rust/doc/src/language/datasets/formats/index.md index f3ffb65db4..8f97e7f10f 100644 --- a/rust/doc/src/language/datasets/formats/index.md +++ b/rust/doc/src/language/datasets/formats/index.md @@ -17,12 +17,12 @@ decimal format. Every variable has two output formats, called its "print format" and "write format". Print formats are used in most output contexts; -only the [`WRITE`](../../../commands/data-io/write.md) command uses -write formats. Newly created variables have identical print and write -formats, and [`FORMATS`](../../../commands/variables/formats.md), the -most commonly used command for changing formats, sets both of them to -the same value as well. This means that the distinction between print -and write formats is usually unimportant. +only the [`WRITE`](../../../commands/write.md) command uses write +formats. Newly created variables have identical print and write +formats, and [`FORMATS`](../../../commands/formats.md), the most +commonly used command for changing formats, sets both of them to the +same value as well. This means that the distinction between print and +write formats is usually unimportant. Input and output formats are specified to PSPP with a "format specification" of the form `TypeW` or `TypeW.D`, where `Type` is one diff --git a/rust/doc/src/language/datasets/formats/legacy-numeric.md b/rust/doc/src/language/datasets/formats/legacy-numeric.md index b923ca5166..9c8c287fc9 100644 --- a/rust/doc/src/language/datasets/formats/legacy-numeric.md +++ b/rust/doc/src/language/datasets/formats/legacy-numeric.md @@ -66,7 +66,7 @@ causes the field to be read as system-missing. The decimal point character for input and output is always `.`, even if the decimal point character is a comma (see [`SET -DECIMAL`](../../../commands/utilities/set.md#decimal)). +DECIMAL`](../../../commands/set.md#decimal)). Nonzero, negative values output in `Z` format are marked as negative even when no nonzero digits are output. For example, -0.2 is diff --git a/rust/doc/src/language/datasets/formats/time-and-date.md b/rust/doc/src/language/datasets/formats/time-and-date.md index dd9f1fcdc5..63646b51f2 100644 --- a/rust/doc/src/language/datasets/formats/time-and-date.md +++ b/rust/doc/src/language/datasets/formats/time-and-date.md @@ -46,9 +46,9 @@ formats are input and output: Year. In output, `DATETIME` and `YMDHMS` always produce 4-digit years; other formats can produce a 2- or 4-digit year. The century assumed for 2-digit years depends on the - [`EPOCH`](../../../commands/utilities/set.md#epoch) setting. In - output, a year outside the epoch causes the whole field to be filled - with asterisks (`*`). + [`EPOCH`](../../../commands/set.md#epoch) setting. In output, a + year outside the epoch causes the whole field to be filled with + asterisks (`*`). * `jjj` Day of year (Julian day), from 1 to 366. This is exactly three @@ -88,7 +88,7 @@ formats are input and output: On input, seconds and fractional seconds are optional. The `DECIMAL` setting controls the character accepted and displayed as the decimal point (see [`SET - DECIMAL`](../../../commands/utilities/set.md#decimal)). + DECIMAL`](../../../commands/set.md#decimal)). For output, the date and time formats use the delimiters indicated in the table. For input, date components may be separated by spaces or by diff --git a/rust/doc/src/language/datasets/index.md b/rust/doc/src/language/datasets/index.md index 656af1bbf7..aa1b66ab96 100644 --- a/rust/doc/src/language/datasets/index.md +++ b/rust/doc/src/language/datasets/index.md @@ -9,6 +9,6 @@ each variable. called the "active dataset". Most PSPP commands work only with the active dataset. In addition to the active dataset, PSPP also supports any number of additional open datasets. The [`DATASET` -commands](../../commands/data-io/dataset.md) can choose a new active -dataset from among those that are open, as well as create and destroy +commands](../../commands/dataset.md) can choose a new active dataset +from among those that are open, as well as create and destroy datasets. diff --git a/rust/doc/src/language/datasets/scratch-variables.md b/rust/doc/src/language/datasets/scratch-variables.md index 61c2f4be8f..3a1ecf6410 100644 --- a/rust/doc/src/language/datasets/scratch-variables.md +++ b/rust/doc/src/language/datasets/scratch-variables.md @@ -8,9 +8,9 @@ system-missing value or to blanks, depending on type. However, sometimes it's useful to have a variable that keeps its value between cases. You can do this with -[`LEAVE`](../../commands/variables/leave.md), or you can use a -"scratch variable". Scratch variables are variables whose names begin -with an octothorpe (`#`). +[`LEAVE`](../../commands/leave.md), or you can use a "scratch +variable". Scratch variables are variables whose names begin with an +octothorpe (`#`). Scratch variables have the same properties as variables left with `LEAVE`: they retain their values between cases, and for the first @@ -18,6 +18,6 @@ case they are initialized to 0 or blanks. They have the additional property that they are deleted before the execution of any procedure. For this reason, scratch variables can't be used for analysis. To use a scratch variable in an analysis, use -[`COMPUTE`](../../commands/data/compute.md) to copy its value into an +[`COMPUTE`](../../commands/compute.md) to copy its value into an ordinary variable, then use that ordinary variable in the analysis. diff --git a/rust/doc/src/language/datasets/variables.md b/rust/doc/src/language/datasets/variables.md index b9ea5409c3..58a7ae64ea 100644 --- a/rust/doc/src/language/datasets/variables.md +++ b/rust/doc/src/language/datasets/variables.md @@ -32,13 +32,12 @@ Each variable has a number of attributes, including: * Position Variables in the dictionary are arranged in a specific order. - [`DISPLAY`](../../commands/variables/display.md) can show this - order. + [`DISPLAY`](../../commands/display.md) can show this order. * Initialization Either reinitialized to 0 or spaces for each case, or left at its - existing value. Use [`LEAVE`](../../commands/variables/leave.md) to - avoid reinitializing a variable. + existing value. Use [`LEAVE`](../../commands/leave.md) to avoid + reinitializing a variable. * Missing values Optionally, up to three values, or a range of values, or a specific @@ -50,36 +49,35 @@ Each variable has a number of attributes, including: while the system-missing value is not a value at all. See [Handling Missing Values](../../language/basics/missing-values.md) for more information on missing values. The [`MISSING - VALUES`](../../commands/variables/missing-values.md) command sets - missing values. + VALUES`](../../commands/missing-values.md) command sets missing + values. * Variable label A string that describes the variable. The [`VARIABLE - LABELS`](../../commands/variables/variable-labels.md) command sets - variable labels. + LABELS`](../../commands/variable-labels.md) command sets variable + labels. * Value label Optionally, these associate each possible value of the variable with - a string. The [`VALUE - LABELS`](../../commands/variables/value-labels.md) and [`ADD VALUE - LABELS`](../../commands/variables/add-value-labels.md) commands set - value labels. + a string. The [`VALUE LABELS`](../../commands/value-labels.md) and + [`ADD VALUE LABELS`](../../commands/add-value-labels.md) commands + set value labels. * Print format Display width, format, and (for numeric variables) number of decimal places. This attribute does not affect how data are stored, just how they are displayed. See [Input and Output Formats](../../language/datasets/formats/index.md) for details. The - [`FORMATS`](../../commands/variables/formats.md) and [`PRINT - FORMATS`](../../commands/variables/print-formats.md) commands set - print formats. + [`FORMATS`](../../commands/formats.md) and [`PRINT + FORMATS`](../../commands/print-formats.md) commands set print + formats. * Write format Similar to print format, but used by the - [`WRITE`](../../commands/data-io/write.md) command. The - [`FORMATS`](../../commands/variables/formats.md) and [`WRITE - FORMATS`](../../commands/variables/write-formats.md) commands set - write formats. + [`WRITE`](../../commands/write.md) command. The + [`FORMATS`](../../commands/formats.md) and [`WRITE + FORMATS`](../../commands/write-formats.md) commands set write + formats. * Measurement level One of the following: @@ -104,8 +102,8 @@ Each variable has a number of attributes, including: attached, such as age in years, income in dollars, or distance in miles. Only numeric variables are scalar. - The [`VARIABLE LEVEL`](../../commands/variables/variable-level.md) - command sets measurement levels. + The [`VARIABLE LEVEL`](../../commands/variable-level.md) command + sets measurement levels. Variables created by `COMPUTE` and similar transformations, obtained from external sources, etc., initially have an unknown @@ -132,20 +130,18 @@ Each variable has a number of attributes, including: - Scale, if the variable has 24 or more unique valid values. The value 24 is the default. Use [`SET - SCALEMIN`](../../commands/utilities/set.md#scalemin) to change the - default. + SCALEMIN`](../../commands/set.md#scalemin) to change the default. Finally, if none of the above is true, PSPP assigns the variable a nominal measurement level. * Custom attributes User-defined associations between names and values. The [`VARIABLE - ATTRIBUTE`](../../commands/variables/variable-attribute.md) command - sets variable atributes. + ATTRIBUTE`](../../commands/variable-attribute.md) command sets + variable atributes. * Role The intended role of a variable for use in dialog boxes in graphical user interfaces. The [`VARIABLE - ROLE`](../../commands/variables/variable-role.md) command sets - variable roles. + ROLE`](../../commands/variable-role.md) command sets variable roles. diff --git a/rust/doc/src/language/expressions/functions/mathematical.md b/rust/doc/src/language/expressions/functions/mathematical.md index 67adb7c860..0baa9216c4 100644 --- a/rust/doc/src/language/expressions/functions/mathematical.md +++ b/rust/doc/src/language/expressions/functions/mathematical.md @@ -35,8 +35,8 @@ results. Halves are rounded away from zero, as are values that fall short of halves by less than `FUZZBITS` of errors in the least-significant bits of X. If `FUZZBITS` is not specified then the default is taken - from [`SET FUZZBITS`](../../../commands/utilities/set.md#fuzzbits), - which is 6 unless overridden. + from [`SET FUZZBITS`](../../../commands/set.md#fuzzbits), which is 6 + unless overridden. * `SQRT(X)` Takes the square root of `X`. If `X` is negative, the result is @@ -49,6 +49,6 @@ results. `FUZZBITS` of errors in the least-significant bits of `X` are rounded away from zero. If `FUZZBITS` is not specified then the default is taken from [`SET - FUZZBITS`](../../../commands/utilities/set.md#fuzzbits), which is 6 - unless overridden. + FUZZBITS`](../../../commands/set.md#fuzzbits), which is 6 unless + overridden. diff --git a/rust/doc/src/language/expressions/functions/statistical.md b/rust/doc/src/language/expressions/functions/statistical.md index eb7d531e13..390c514518 100644 --- a/rust/doc/src/language/expressions/functions/statistical.md +++ b/rust/doc/src/language/expressions/functions/statistical.md @@ -4,8 +4,8 @@ Statistical functions compute descriptive statistics on a list of values. Some statistics can be computed on numeric or string values; other can only be computed on numeric values. Their results have the same type as their arguments. The current case's -[weight](../../../commands/selection/weight.md) has no effect on -statistical functions. +[weight](../../../commands/weight.md) has no effect on statistical +functions. These functions' argument lists may include entire ranges of variables using the `VAR1 TO VAR2` syntax. diff --git a/rust/doc/src/language/expressions/functions/time-and-date.md b/rust/doc/src/language/expressions/functions/time-and-date.md index 505de29732..053dc3ecda 100644 --- a/rust/doc/src/language/expressions/functions/time-and-date.md +++ b/rust/doc/src/language/expressions/functions/time-and-date.md @@ -90,8 +90,8 @@ represent dates. Arguments taken by these functions are: * `YEAR` Refers to a year, 1582 or greater. Years between 0 and 99 are treated according to the epoch set on [`SET - EPOCH`](../../../commands/utilities/set.md#epoch), by default - beginning 69 years before the current date. + EPOCH`](../../../commands/set.md#epoch), by default beginning 69 + years before the current date. If these functions' arguments are out-of-range, they are correctly normalized before conversion to date format. Non-integers are rounded diff --git a/rust/doc/src/language/files/file-handles.md b/rust/doc/src/language/files/file-handles.md index a82f033add..1b0cdfd813 100644 --- a/rust/doc/src/language/files/file-handles.md +++ b/rust/doc/src/language/files/file-handles.md @@ -12,7 +12,7 @@ from a file using a program such as `zcat` (e.g. `GET '|zcat mydata.sav.gz'`), and for many other purposes. PSPP also supports declaring named file handles with the [`FILE -HANDLE`](../../commands/data-io/file-handle.md) command. This command +HANDLE`](../../commands/file-handle.md) command. This command associates an identifier of your choice (the file handle's name) with a file. Later, the file handle name can be substituted for the name of the file. When PSPP syntax accesses a file multiple times, @@ -30,10 +30,10 @@ writes a portable file; otherwise, PSPP writes a system file. `INLINE` is reserved as a file handle name. It refers to the "data file" embedded into the syntax file between [`BEGIN DATA` and `END -DATA`](../../commands/data-io/begin-data.md). +DATA`](../../commands/begin-data.md). The file to which a file handle refers may be reassigned on a later `FILE HANDLE` command if it is first closed using [`CLOSE FILE -HANDLE`](../../commands/data-io/close-file-handle.md). +HANDLE`](../../commands/close-file-handle.md). diff --git a/rust/doc/src/language/files/index.md b/rust/doc/src/language/files/index.md index ba79c822d1..ab2779cce2 100644 --- a/rust/doc/src/language/files/index.md +++ b/rust/doc/src/language/files/index.md @@ -9,8 +9,8 @@ most important of these files: These names (synonyms) refer to the file that contains instructions that tell PSPP what to do. The syntax file's name is specified on the PSPP command line. Syntax files can also be read with - [`INCLUDE`](../../commands/utilities/include.md) or - [`INSERT`](../../commands/utilities/insert.md). + [`INCLUDE`](../../commands/include.md) or + [`INSERT`](../../commands/insert.md). * data file Data files contain raw data in text or binary format. Data can diff --git a/rust/doc/src/language/tutorial/hypotheses.md b/rust/doc/src/language/tutorial/hypotheses.md index 4806cb3282..c8cd9f8993 100644 --- a/rust/doc/src/language/tutorial/hypotheses.md +++ b/rust/doc/src/language/tutorial/hypotheses.md @@ -174,9 +174,9 @@ improve the accuracy of their quotations. It was suggested that the time to repair might be related to the time between failures and the duty cycle of the equipment. The p-value of 0.1 was chosen for this investigation. In order to investigate this hypothesis, the -[`REGRESSION`](../../commands/statistics/regression.md) command was -used. This command not only tests if the variables are related, but -also identifies the potential linear relationship. +[`REGRESSION`](../../commands/regression.md) command was used. This +command not only tests if the variables are related, but also +identifies the potential linear relationship. A first attempt includes `duty_cycle`: diff --git a/rust/doc/src/language/tutorial/preparation.md b/rust/doc/src/language/tutorial/preparation.md index d5f0b3791c..a266ecac1b 100644 --- a/rust/doc/src/language/tutorial/preparation.md +++ b/rust/doc/src/language/tutorial/preparation.md @@ -48,11 +48,11 @@ PSPP> There are several things to note about this example. - The words `data list list` are an example of the [`DATA - LIST`](../../commands/data-io/data-list.md). command, which tells - PSPP to prepare for reading data. The word `list` intentionally - appears twice. The first occurrence is part of the `DATA LIST` - call, whilst the second tells PSPP that the data is to be read as - free format data with one record per line. + LIST`](../../commands/data-list.md). command, which tells PSPP to + prepare for reading data. The word `list` intentionally appears + twice. The first occurrence is part of the `DATA LIST` call, whilst + the second tells PSPP that the data is to be read as free format + data with one record per line. Usually this manual shows command names and other fixed elements of syntax in upper case, but case doesn't matter in most parts of @@ -115,7 +115,7 @@ following output: Note that the numeric variable height is displayed to 2 decimal places, because the format for that variable is `F8.2`. For a complete description of the `LIST` command, see -[`LIST`](../../commands/data-io/list.md). +[`LIST`](../../commands/list.md). ## Reading data from a text file @@ -143,7 +143,7 @@ however, that it is still necessary to specify the names of the variables and their formats, since this information is not contained in the file. It is also possible to specify the file's character encoding and other parameters. For full details refer to [`DATA -LIST`](../../commands/data-io/data-list.md). +LIST`](../../commands/data-list.md). ## Reading data from a pre-prepared PSPP file @@ -181,8 +181,8 @@ Otherwise it will be created. Sometimes it's useful to be able to read data from comma separated text, from spreadsheets, databases or other sources. In these -instances you should use the [`GET -DATA`](../../commands/spss-io/get-data.md) command. +instances you should use the [`GET DATA`](../../commands/get-data.md) +command. ## Exiting PSPP diff --git a/rust/doc/src/language/tutorial/transformations.md b/rust/doc/src/language/tutorial/transformations.md index 1975bfb257..8b9ed6aa41 100644 --- a/rust/doc/src/language/tutorial/transformations.md +++ b/rust/doc/src/language/tutorial/transformations.md @@ -10,14 +10,14 @@ Data from real sources is rarely error free. PSPP has a number of procedures which can be used to help identify data which might be incorrect. -The [`DESCRIPTIVES`](../../commands/statistics/descriptives.md) -command is used to generate simple linear statistics for a dataset. -It is also useful for identifying potential problems in the data. The -example file `physiology.sav` contains a number of physiological -measurements of a sample of healthy adults selected at random. -However, the data entry clerk made a number of mistakes when entering -the data. The following example illustrates the use of `DESCRIPTIVES` -to screen this data and identify the erroneous values: +The [`DESCRIPTIVES`](../../commands/descriptives.md) command is used +to generate simple linear statistics for a dataset. It is also useful +for identifying potential problems in the data. The example file +`physiology.sav` contains a number of physiological measurements of a +sample of healthy adults selected at random. However, the data entry +clerk made a number of mistakes when entering the data. The following +example illustrates the use of `DESCRIPTIVES` to screen this data and +identify the erroneous values: ``` PSPP> get file='/usr/local/share/pspp/examples/physiology.sav'. @@ -97,7 +97,7 @@ decide to disregard these values. PSPP has a feature for [missing values](../../language/basics/missing-values.md), whereby data can assume the special value 'SYSMIS', and will be disregarded in future analysis. You can set the two suspect values to the `SYSMIS` value -using the [`RECODE`](../../commands/data/recode.md) command. +using the [`RECODE`](../../commands/recode.md) command. ``` PSPP> recode height (179 = SYSMIS). @@ -204,9 +204,9 @@ recode v3 (1 = 5) (2 = 4) (4 = 2) (5 = 1). ``` However an easier and more elegant way uses the -[`COMPUTE`](../../commands/data/compute.md) command. Since the -variables are Likert variables in the range (1 ... 5), subtracting -their value from 6 has the effect of inverting them: +[`COMPUTE`](../../commands/compute.md) command. Since the variables +are Likert variables in the range (1 ... 5), subtracting their value +from 6 has the effect of inverting them: ``` compute VAR = 6 - VAR. @@ -224,11 +224,10 @@ questionnaires have been completed thoughtfully. If you examine the labels of variables v1, v3 and v4, you will notice that they ask very similar questions. One would therefore expect the values of these variables (after recoding) to closely follow one another, and we can -test that with the -[`RELIABILITY`](../../commands/statistics/reliability.md) command. -The following example shows a PSPP session where the user recodes -negatively scaled variables and then requests reliability statistics -for v1, v3, and v4. +test that with the [`RELIABILITY`](../../commands/reliability.md) +command. The following example shows a PSPP session where the user +recodes negatively scaled variables and then requests reliability +statistics for v1, v3, and v4. ``` PSPP> get file='/usr/local/share/pspp/examples/hotel.sav'. @@ -379,7 +378,6 @@ close to zero. This provides some confidence that the mtbf_ln variable is normally distributed and thus safe for linear analysis. In the event that no suitable transformation can be found, then it would be worth considering an appropriate non-parametric test instead -of a linear one. See [`NPAR -TESTS`](../../commands/statistics/npar-tests.md), for information -about non-parametric tests. +of a linear one. See [`NPAR TESTS`](../../commands/npar-tests.md), +for information about non-parametric tests. diff --git a/rust/doc/src/pc+.md b/rust/doc/src/pc+.md index c7ba165003..558d413603 100644 --- a/rust/doc/src/pc+.md +++ b/rust/doc/src/pc+.md @@ -158,8 +158,8 @@ char label[64]; seconds are always written as two digits. * `char file_label[64];` - [File label](commands/utilities/file-label.md) declared by the user, - if any. Padded on the right with spaces. + [File label](commands/file-label.md) declared by the user, if any. + Padded on the right with spaces. ## Record 1: Variables Record diff --git a/rust/doc/src/spv/light-detail.md b/rust/doc/src/spv/light-detail.md index 34ad22c6b7..17337d0a8c 100644 --- a/rust/doc/src/spv/light-detail.md +++ b/rust/doc/src/spv/light-detail.md @@ -529,8 +529,8 @@ language; it is often empty and, when it is not, sometimes the same as `command`. `include-leading-zero` is the -[`LEADZERO`](../commands/utilities/set.md#leadzero) setting for the -table, where false is `OFF` (the default) and true is `ON`. +[`LEADZERO`](../commands/set.md#leadzero) setting for the table, where +false is `OFF` (the default) and true is `ON`. `missing` is the character used to indicate that a cell contains a missing value. It is always observed as `.`. -- 2.30.2