comparison extra/NaN/inst/xptopen.m @ 12701:794b03395bbd octave-forge

add help file for xptopen
author schloegl
date Tue, 22 Dec 2015 00:48:47 +0000
parents 3fa7cfe44c4c
children
comparison
equal deleted inserted replaced
12700:2ebf4955381e 12701:794b03395bbd
1 % XPTOPEN read of several file formats and writing of the SAS Transport Format (*.xpt) 1 % XPTOPEN read of several file formats and writing of the SAS Transport Format (*.xpt)
2 % Supported are ARFF, SAS-XPT and STATA files.
3 % XPTOPEN is a mex-file and must be compiled before use.
4 % More detailed help can be obtained by the command
5 % xptopen
6 % without an additional argument
7 % 2 %
8 % X = xptopen(filename) 3 % X = xptopen(filename)
9 % X = xptopen(filename,'r') 4 % X = xptopen(filename,'r')
10 % read file with filename and return variables in struct X 5 % read filename and return variables in struct X
6 % Supported are ARFF, SAS-XPT and STATA files.
11 % 7 %
12 % X = xptopen(filename,'w',X) 8 % X = xptopen(filename,'w',X)
13 % save fields of struct X in filename. 9 % save fields of struct X in filename.
14 %
15 % The fields of X must be column vectors of equal length.
16 % Each vector is either a numeric vector or a cell array of strings.
17 % The SAS-XPT format stores Date/Time as numeric value counting the number of days since 1960-01-01.
18 % 10 %
19 % References: 11 % The fields of X must be column vectors of equal length.
20 % [1] TS-140 THE RECORD LAYOUT OF A DATA SET IN SAS TRANSPORT (XPORT) FORMAT 12 % Each vector is either a numeric vector or a cell array of strings.
21 % http://support.sas.com/techsup/technote/ts140.html 13 %
22 % [2] IBM floating point format 14 % The SAS-XPT format stores Date/Time as numeric value counting the number of days since 1960-01-01.
23 % http://en.wikipedia.org/wiki/IBM_Floating_Point_Architecture
24 % [3] see http://old.nabble.com/Re%3A-IBM-integer-and-double-formats-p20428979.html
25 % [4] STATA File Format
26 % http://www.stata.com/help.cgi?dta
27 % http://www.stata.com/help.cgi?dta_113
28 15
29 16 % Copyright (C) 2015 by Alois Schloegl <alois.schloegl@gmail.com>
30 % This program is free software; you can redistribute it and/or modify 17 % This is part of the NaN-toolbox. For more details see
31 % it under the terms of the GNU General Public License as published by 18 % https://pub.ist.ac.at/~schloegl/matlab/NaN/
32 % the Free Software Foundation; either version 3 of the License, or
33 % (at your option) any later version.
34 % 19 %
35 % This program is distributed in the hope that it will be useful, 20 % This program is free software; you can redistribute it and/or modify
36 % but WITHOUT ANY WARRANTY; without even the implied warranty of 21 % it under the terms of the GNU General Public License as published by
37 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 % the Free Software Foundation; either version 3 of the License, or
38 % GNU General Public License for more details. 23 % (at your option) any later version.
39 % 24 %
40 % You should have received a copy of the GNU General Public License 25 % This program is distributed in the hope that it will be useful,
41 % along with this program; If not, see <http://www.gnu.org/licenses/>. 26 % but WITHOUT ANY WARRANTY; without even the implied warranty of
42 27 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
43 28 % GNU General Public License for more details.
44 % $Id$ 29 %
45 % Copyright (C) 2010,2011,2012,2014 by Alois Schloegl <alois.schloegl@ist.ac.at> 30 % You should have received a copy of the GNU General Public License
46 % This is part of the NaN-toolbox. For more details see 31 % along with this program; If not, see <http://www.gnu.org/licenses/>.
47 % http://pub.ist.ac.at/~schloegl/matlab/NaN/
48
49
50 if exist('xptopen','file')~=3
51 error('xptopen.mex is not compiled')
52 end;
53