| .. pyreadstat documentation master file, created by |
| sphinx-quickstart on Wed May 30 17:03:20 2018. |
| You can adapt this file completely to your liking, but it should at least |
| contain the root `toctree` directive. |
|
|
| Welcome to pyreadstat's documentation! |
| ====================================== |
|
|
| .. toctree:: |
| :maxdepth: 2 |
| :caption: Contents: |
|
|
| Metadata Object Description |
| =========================== |
|
|
| Each parsing function returns a metadata object in addition to a pandas dataframe. That |
| object contains the following fields: |
|
|
| * notes: notes or documents (text annotations) attached to the file if any (spss and stata). |
| * creation_time: time of creation of the file by the application. |
| * modification_time: time of modification of the file by the application. |
| * column_names : a list with the names of the columns. |
| * column_labels : a list with the column labels, if any. |
| * column_names_to_labels : a dictionary with column_names as keys and column_labels as values |
| * file_encoding : a string with the file encoding, may be empty |
| * number_columns : an int with the number of columns |
| * number_rows : an int with the number of rows. If metadataonly option was used, it may |
| be None if the number of rows could not be determined. If you need the number of rows in |
| this case you need to parse the whole file. This happens for xport and por files. |
| * variable_value_labels : a dict with keys being variable names, and values being a dict with values as keys and labels |
| as values. It may be empty if the dataset did not contain such labels. For sas7bdat files it will be empty unless |
| a sas7bcat was given. It is a combination of value_labels and variable_to_label. |
| * value_labels : a dict with label name as key and a dict as value, with values as keys and labels |
| as values. In the case of parsing a sas7bcat file this is where the formats are. |
| * variable_to_label : A dict with variable name as key and label name as value. Label names are those described in |
| value_labels. Sas7bdat files may have this member populated and its information can be used to match the information |
| in the value_labels coming from the sas7bcat file. |
| * original_variable_types : a dict of variable name to variable format in the original file. For debugging purposes. |
| * readstat_variable_types : a dict of variable name to variable type in the original file as extracted by Readstat.i |
| For debugging purposes. In SAS and SPSS variables will be either double (numeric in the original app) or string (character). |
| Stata has in addition int8, int32 and float types. |
| * table_name : table name (string) |
| * file_label : file label (SAS) (string) |
| * missing_ranges: a dict with keys being variable names. Values are a list of dicts. Each dict contains two |
| keys, 'lo' and 'hi' being the lower boundary and higher boundary for the missing range. Even if the value in both |
| lo and hi are the same, the two elements will always be present. This appears for SPSS (sav) files when using the |
| option user_missing=True: user defined missing values appear not as nan but as their true value and this dictionary |
| stores the information about which values are to be considered missing. |
| * missing_user_values: a dict with keys being variable names. Values are a list of character values (A to Z and _ for SAS, a to z for SATA) representing user defined |
| missing values in SAS and STATA. This appears when using user_missing=True in read_sas7bdat or read_dta if user defined missing values are present. |
| * variable_alignment: a dict with keys being variable names and values being the display alignment: left, center, right or unknown |
| * variable_storage_width: a dict with keys being variable names and values being the storage width |
| * variable_display_width: a dict with keys being variable names and values being the display width |
| * variable_measure: a dict with keys being variable names and values being the measure: nominal, ordinal, scale or unknown |
| * mr_sets: a dictionary representing the definitions of multiple-response (MR) |
| variables in the dataset (currently only supported for SAV format). MR variables |
| are arrays composed of several other variables. This metadata entry, `mr_sets`, |
| specifies which variables are combined to form each array. Each entry includes: |
| `type`, `is_dichotomy`, `counted_value`, `label`, and `variable_list`. The meaning |
| of these fields is based on the SPSS specification for multiple-response sets. |
|
|
|
|
| There are two functions to deal with value labels: set_value_labels and set_catalog_to_sas. You can read about them |
| in the next section. |
|
|
| Functions Documentation |
| ======================= |
|
|
| .. automodule:: pyreadstat.pyreadstat |
| :members: |
| :undoc-members: |
| |
|
|
|
|
| Indices and tables |
| ================== |
|
|
| * :ref:`genindex` |
| * :ref:`modindex` |
| * :ref:`search` |
|
|
