|
|
|
Libgretl Reference Manual | |
|---|---|---|---|---|
| Top | Description | ||||
enum GretlFileType; enum DataClearCode; enum GretlVarnameError; #define SPREADSHEET_IMPORT (f) #define OTHER_IMPORT (f) #define free_datainfo (p) #define DBNA #define GRETL_SCALAR_DIGITS int dateton (const char *date, const DATAINFO *pdinfo); char * ntodate (char *datestr, int t, const DATAINFO *pdinfo); int get_subperiod (int t, const DATAINFO *pdinfo, int *err); int get_info (const char *hdrfile, PRN *prn); int get_precision (const double *x, int n, int placemax); double get_date_x (int pd, const char *obs); int write_data (const char *fname, int *list, const double **Z, const DATAINFO *pdinfo, gretlopt opt, int progress); int is_gzipped (const char *fname); int gretl_is_pkzip_file (const char *fname); void gz_switch_ext (char *targ, char *src, char *ext); int merge_or_replace_data (double ***pZ0, DATAINFO *pdinfo0, double ***pZ1, DATAINFO **ppdinfo1, gretlopt opt, PRN *prn); int gretl_get_data (char *datfile, double ***pZ, DATAINFO *pdinfo, gretlopt opt, PRN *prn); int open_nulldata (double ***pZ, DATAINFO *pdinfo, int data_status, int length, PRN *prn); int import_csv (const char *fname, double ***pZ, DATAINFO *pdinfo, gretlopt opt, PRN *prn); int import_spreadsheet (const char *fname, int ftype, int *list, char *sheetname, double ***pZ, DATAINFO *pdinfo, gretlopt opt, PRN *prn); int import_other (const char *fname, int ftype, double ***pZ, DATAINFO *pdinfo, gretlopt opt, PRN *prn); int add_obs_markers_from_file (DATAINFO *pdinfo, const char *fname); GretlFileType detect_filetype (char *fname); gretlopt data_save_opt_from_suffix (const char *fname); int check_varname (const char *varname); int check_atof (const char *numstr); int check_atoi (const char *numstr); int transpose_data (double ***pZ, DATAINFO *pdinfo); void dataset_add_import_info (DATAINFO *pdinfo, const char *fname, GretlFileType type);
typedef enum {
GRETL_NATIVE_DATA, /* gretl native format data file */
GRETL_XML_DATA, /* gretl xml format data file */
GRETL_CSV, /* comma-separated data file */
GRETL_OCTAVE, /* GNU octave ascii data file */
GRETL_GNUMERIC, /* gnumeric workbook data */
GRETL_XLS, /* MS Excel spreadsheet data */
GRETL_ODS, /* Open Document Spreadsheet data */
GRETL_WF1, /* Eviews workfile data */
GRETL_DTA, /* Stata .dta data */
GRETL_SAV, /* SPSS .sav data */
GRETL_SAS, /* SAS xport data file */
GRETL_SCRIPT, /* file containing gretl commands */
GRETL_SESSION, /* zipped session file */
GRETL_NATIVE_DB, /* gretl database */
GRETL_NATIVE_DB_WWW, /* gretl database, accessed via internet */
GRETL_RATS_DB, /* RATS 4.0 database */
GRETL_PCGIVE_DB, /* PcGive bn7/in7 pair */
GRETL_JMULTI, /* JMulTi data file */
GRETL_ODBC, /* Open DataBase Connectivity */
GRETL_UNRECOGNIZED /* none of the above */
} GretlFileType;
typedef enum {
CLEAR_FULL, /* fully clear the dataset */
CLEAR_SUBSAMPLE /* dataset is sub-sampled: clear partially */
} DataClearCode;
typedef enum {
VARNAME_RESERVED = 1, /* vername is a gretl reserved name */
VARNAME_FIRSTCHAR, /* first character is not alphabetical */
VARNAME_BADCHAR /* illegal character in second or subsequent place */
} GretlVarnameError;
int dateton (const char *date,
const DATAINFO *pdinfo);
Given a "current" date string, a periodicity, and a starting date string, returns the observation number corresponding to the current date string, counting from zero.
date : |
string representation of date for processing. |
pdinfo : |
pointer to data information struct. |
| Returns : | integer observation number. |
char * ntodate (char *datestr,
int t,
const DATAINFO *pdinfo);
print to datestr the calendar representation of observation
number t.
datestr : |
string to which date is to be printed. |
t : |
an observation number (zero-based). |
pdinfo : |
data information struct. |
| Returns : | the observation string. |
int get_subperiod (int t,
const DATAINFO *pdinfo,
int *err);
t : |
|
pdinfo : |
|
err : |
|
| Returns : |
int get_info (const char *hdrfile,
PRN *prn);
print to prn the informative comments contained in the given
data file (if any).
hdrfile : |
name of data header file |
prn : |
gretl printing struct. |
| Returns : | 0 on successful completion, non-zero on error or if there are no informative comments. |
int get_precision (const double *x,
int n,
int placemax);
Find the number of decimal places required to represent a given data series uniformly.
x : |
data vector. |
n : |
length of x. |
placemax : |
maximum number of decimal places to try. |
| Returns : | the required number of decimal places. |
int write_data (const char *fname,
int *list,
const double **Z,
const DATAINFO *pdinfo,
gretlopt opt,
int progress);
Write out a data file containing the values of the given set of variables.
fname : |
name of file to write. |
list : |
list of variables to write (or NULL to write all series).
|
Z : |
data matrix. |
pdinfo : |
data information struct. |
opt : |
option flag indicating format in which to write the data. |
progress : |
may be 1 when called from gui to display progress bar in case of a large data write; generally should be 0. |
| Returns : | 0 on successful completion, non-zero on error. |
int is_gzipped (const char *fname);
Determine if the given file is gzipped.
fname : |
filename to examine. |
| Returns : | 1 in case of a gzipped file, 0 if not gzipped or inaccessible. |
void gz_switch_ext (char *targ,
char *src,
char *ext);
Copy src filename to targ, without the existing suffix (if any),
and adding the supplied extension or suffix.
targ : |
target or "output" filename (must be pre-allocated). |
src : |
"source or "input" filename. |
ext : |
suffix to add to filename. |
int merge_or_replace_data (double ***pZ0,
DATAINFO *pdinfo0,
double ***pZ1,
DATAINFO **ppdinfo1,
gretlopt opt,
PRN *prn);
Given a newly-created dataset, pointed to by pZ1 and
ppdinfo1, either attempt to merge it with pZ0, if the
original dataset is non-NULL, or replace the content of
the original pointers with the new dataset.
In case merging is not successful, the new dataset is
destroyed.
pZ0 : |
pointer to original data set. |
pdinfo0 : |
original dataset information struct. |
pZ1 : |
new data set. |
ppdinfo1 : |
pointer to dataset information associated with pZ1.
|
opt : |
may include OPT_T when appending to a panel dataset,
to force a time-series interpretation of the added data.
|
prn : |
print struct to accept messages. |
| Returns : | 0 on successful completion, non-zero otherwise. |
int gretl_get_data (char *datfile,
double ***pZ,
DATAINFO *pdinfo,
gretlopt opt,
PRN *prn);
Read data from file into gretl's work space, allocating space as required.
datfile : |
name of file to try. |
pZ : |
pointer to data set. |
pdinfo : |
pointer to data information struct. |
opt : |
for use with "append". |
prn : |
where messages should be written. |
| Returns : | 0 on successful completion, non-zero otherwise. |
int open_nulldata (double ***pZ,
DATAINFO *pdinfo,
int data_status,
int length,
PRN *prn);
Create an empty "dummy" data set, suitable for Monte Carlo simulations.
pZ : |
pointer to data set. |
pdinfo : |
data information struct. |
data_status : |
indicator for whether a data file is currently open in gretl's work space (1) or not (0). |
length : |
desired length of data series. |
prn : |
gretl printing struct. |
| Returns : | 0 on successful completion, non-zero otherwise. |
int import_csv (const char *fname,
double ***pZ,
DATAINFO *pdinfo,
gretlopt opt,
PRN *prn);
Open a Comma-Separated Values data file and read the data into the current work space.
fname : |
name of CSV file. |
pZ : |
pointer to data set. |
pdinfo : |
pointer to data information struct. |
opt : |
use OPT_C to force interpretation of data colums containing
strings as coded values and not errors; for use of OPT_T see
the help for "append".
|
prn : |
gretl printing struct (or NULL).
|
| Returns : | 0 on successful completion, non-zero otherwise. |
int import_spreadsheet (const char *fname,
int ftype,
int *list,
char *sheetname,
double ***pZ,
DATAINFO *pdinfo,
gretlopt opt,
PRN *prn);
Open a data file of a type that requires a special plugin.
fname : |
name of file. |
ftype : |
type of data file. |
list : |
list of parameters for spreadsheet import, or NULL.
|
sheetname : |
name of worksheet, or NULL.
|
pZ : |
pointer to data set. |
pdinfo : |
pointer to data information struct. |
opt : |
for use with "append". |
prn : |
gretl printing struct. |
| Returns : | 0 on successful completion, non-zero otherwise. |
int import_other (const char *fname,
int ftype,
double ***pZ,
DATAINFO *pdinfo,
gretlopt opt,
PRN *prn);
Open a data file of a type that requires a special plugin.
fname : |
name of file. |
ftype : |
type of data file. |
pZ : |
pointer to data set. |
pdinfo : |
pointer to data information struct. |
opt : |
for use with "append". |
prn : |
gretl printing struct. |
| Returns : | 0 on successful completion, non-zero otherwise. |
int add_obs_markers_from_file (DATAINFO *pdinfo, const char *fname);
Read case markers (strings of OBSLEN - 1 characters or less that identify
the observations) from a file, and associate them with the
current data set. The file should contain one marker per line,
with a number of lines equal to the number of observations in
the current data set.
pdinfo : |
data information struct. |
fname : |
name of file containing case markers. |
| Returns : | 0 on successful completion, non-zero otherwise. |
GretlFileType detect_filetype (char *fname);
Attempt to determine the type of a file to be opened in gretl: data file (of various formats), or command script.
fname : |
name of file to examine. |
| Returns : | integer code indicating the type of file. |
gretlopt data_save_opt_from_suffix (const char *fname);
fname : |
|
| Returns : |
int check_varname (const char *varname);
Check a variable/object name for legality: the name must start with a letter, and be composed of letters, numbers or the underscore character, and nothing else.
varname : |
putative name for variable (or object). |
| Returns : | 0 if name is OK, non-zero if not. |
int check_atof (const char *numstr);
numstr : |
string to check. |
| Returns : | 0 if numstr is blank, or is a valid string representation
of a floating point number, else 1.
|
int check_atoi (const char *numstr);
numstr : |
string to check. |
| Returns : | 0 if numstr is blank, or is a valid string representation
of an int, else 1.
|
int transpose_data (double ***pZ,
DATAINFO *pdinfo);
Attempts to transpose the current dataset, so that each variable becomes interpreted as an observation and each observation as a variable. This will not work if the dataset contains scalar variables.
pZ : |
pointer to data array. |
pdinfo : |
pointer to dataset information struct. |
| Returns : | 0 on success, non-zero error code on error. |
void dataset_add_import_info (DATAINFO *pdinfo, const char *fname, GretlFileType type);
pdinfo : |
|
fname : |
|
type : |