SPREADSHEET_IMPORT()

#define             SPREADSHEET_IMPORT(f)

OTHER_IMPORT()

#define             OTHER_IMPORT(f)

free_datainfo()

#define             free_datainfo(p)

dateton ()

int
dateton (const char *date,
         const DATASET *dset);

Determines the observation number corresponding to date , relative to dset . It is an error if date represents an observation that lies outside of the full data range specified in dset .

merge_dateton ()

int
merge_dateton (const char *date,
               const DATASET *dset);

Works just as dateton(), except that for this function it is not an error if date represents an observation that lies beyond the data range specified in dset . This is inended for use when merging data, or when creating a new dataset.

ntolabel ()

char *
ntolabel (char *datestr,
          int t,
          const DATASET *dset);

Prints to datestr (which must be at least OBSLEN bytes) the calendar representation of observation number t .

ntolabel_8601 ()

char *
ntolabel_8601 (char *datestr,
               int t,
               const DATASET *dset);

get_subperiod ()

int
get_subperiod (int t,
               const DATASET *dset,
               int *err);

For "seasonal" time series data (in a broad sense), determines the sub-period at observation t . The "sub-period" might be a quarter, month, hour or whatever. The value returned is zero-based (e.g. first quarter = 0). If the data are not "seasonal", 0 is returned and if err is non-NULL it receives a non-zero error code.

get_precision ()

int
get_precision (const double *x,
               int n,
               int placemax);

Find the number of decimal places required to represent a given data series uniformly and accurately, if possible.

get_date_x ()

double
get_date_x (int pd,
            const char *obs);

date_maj_min ()

void
date_maj_min (int t,
              const DATASET *dset,
              int *maj,
              int *min);

write_data ()

int
write_data (const char *fname,
            int *list,
            const DATASET *dset,
            gretlopt opt,
            PRN *prn);

Write out a data file containing the values of the given set of variables.

gui_write_data ()

int
gui_write_data (const char *fname,
                int *list,
                const DATASET *dset,
                gretlopt opt);

is_gzipped ()

int
is_gzipped (const char *fname);

Determine if the given file is gzipped.

gretl_is_pkzip_file ()

int
gretl_is_pkzip_file (const char *fname);

get_merge_opts ()

gretlopt
get_merge_opts (gretlopt opt);

merge_or_replace_data ()

int
merge_or_replace_data (DATASET *dset0,
                       DATASET **pdset1,
                       gretlopt opt,
                       PRN *prn);

Given a newly-created dataset, pointed to by pdset1 , either attempt to merge it with dset0 , if the original data array is non-NULL, or replace the content of the original pointer with the new dataset.

In case merging is not successful, the new dataset is destroyed.

gretl_get_data ()

int
gretl_get_data (char *fname,
                DATASET *dset,
                gretlopt opt,
                PRN *prn);

Read "native" data from file into gretl's work space, allocating space as required. This function handles both native XML data format and native binary format. It also handles incomplete information: it can perform path-searching on fname , and will try adding the .gdt or .gdtb extension to fname if this is not given.

Note that a more straightforward function for reading a native gretl data file, given the correct path, is gretl_read_gdt().

The only applicable option is that opt may contain OPT_T when appending data to a panel dataset: in that case we try to interpret the new data as time series, in common across all panel units. In most cases, just give OPT_NONE.

open_nulldata ()

int
open_nulldata (DATASET *dset,
               int data_status,
               int length,
               gretlopt opt,
               PRN *prn);

Create an empty "dummy" data set, suitable for simulations.

import_csv ()

int
import_csv (const char *fname,
            DATASET *dset,
            gretlopt opt,
            PRN *prn);

import_spreadsheet ()

int
import_spreadsheet (const char *fname,
                    GretlFileType ftype,
                    int *list,
                    char *sheetname,
                    DATASET *dset,
                    gretlopt opt,
                    PRN *prn);

Open a data file of a type that requires a special plugin. Acceptable values for ftype are GRETL_GNUMERIC, GRETL_XLS, GRETL_XLSX and GRETL_ODS.

import_other ()

int
import_other (const char *fname,
              GretlFileType ftype,
              DATASET *dset,
              gretlopt opt,
              PRN *prn);

Open a data file of a type that requires a special plugin.

peek_at_csv ()

int
peek_at_csv (const char *fname,
             int n_lines,
             PRN *prn);

gretl_read_purebin ()

int
gretl_read_purebin (const char *fname,
                    DATASET *dset,
                    gretlopt opt,
                    PRN *prn);

add_obs_markers_from_file ()

int
add_obs_markers_from_file (DATASET *dset,
                           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.

add_var_labels_from_file ()

int
add_var_labels_from_file (DATASET *dset,
                          const char *fname);

Read descriptive variables for labels (strings of MAXLABEL - 1 characters or less) from a file, and associate them with the current data set. The file should contain one label per line, with a number of lines equal to the number of variables in the current data set, excluding the constant.

save_var_labels_to_file ()

int
save_var_labels_to_file (const DATASET *dset,
                         const char *fname);

Writes to fname the descriptive labels for the series in the current dataset.

dataset_has_var_labels ()

int
dataset_has_var_labels (const DATASET *dset);

read_or_write_var_labels ()

int
read_or_write_var_labels (gretlopt opt,
                          DATASET *dset,
                          PRN *prn);

read_or_write_obs_markers ()

int
read_or_write_obs_markers (gretlopt opt,
                           DATASET *dset,
                           PRN *prn);

data_file_type_from_name ()

GretlFileType
data_file_type_from_name (const char *fname);

detect_filetype ()

GretlFileType
detect_filetype (char *fname,
                 gretlopt opt);

Attempts to determine the type of a file to be opened in gretl: data file (of various formats), or command script. If OPT_P is given, the fname argument must be an array of length at least MAXLEN: a path may be prepended and in some cases an extension may be appended.

check_varname ()

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.

check_identifier ()

int
check_identifier (const char *varname);

check_atof ()

int
check_atof (const char *numstr);

check_atoi ()

int
check_atoi (const char *numstr);

transpose_data ()

int
transpose_data (DATASET *dset);

Attempts to transpose the current dataset, so that each variable becomes interpreted as an observation and each observation as a variable.

dataset_add_import_info ()

void
dataset_add_import_info (DATASET *dset,
                         const char *fname,
                         GretlFileType type);

On successful import of data from some "foreign" format, add a note to the "descrip" member of the new dataset saying where it came from and when.

analyse_daily_import ()

int
analyse_daily_import (const DATASET *dset,
                      PRN *prn);

set_dset_matrix_target ()

void
set_dset_matrix_target (gretl_matrix **pm);

get_dset_matrix_target ()

void *
get_dset_matrix_target (void);

enum GretlFileType

enum DataClearCode

DBNA

#define DBNA  -999.0 /* missing value code for gretl databases */

GRETL_SCALAR_DIGITS

#define GRETL_SCALAR_DIGITS 12