sampotools.api.load_asd

sampotools.api.load_asd(asd_file)

Loads a saved ASD (Attribute Schema Description) File as an ASD Object.

Parameters
asd_filestr

Path to a saved ASD File.

Returns
asd_objectOrderedDict
Raises
ValidationError
  • If asd_file is not string.

Examples

Loading an ASD file.

  • my_data.asd:

    _sid: {scale: INTEGER}
    col1: {scale: INTEGER}
    _datetime: {scale: DATE}
    col3: {scale: DATE}
    col4: {scale: REAL}
    col5: {domain: [aaa, bbb, ccc], scale: NOMINAL}
    col6: {domain: [ccc, ddd], scale: NOMINAL}
    col7: {scale: DATE}
    
>>> from sampotools.api import load_asd
>>> asd = load_asd('./my_data.asd')
>>> asd
OrderedDict([('_sid', {'scale': 'INTEGER'}),
             ('col1', {'scale': 'INTEGER'}),
             ('_datetime', {'scale': 'DATE'}),
             ('col3', {'scale': 'DATE'}),
             ('col4', {'scale': 'REAL'}),
             ('col5', {'scale': 'NOMINAL', 'domain': ['aaa', 'bbb', 'ccc']}),
             ('col6', {'scale': 'NOMINAL', 'domain': ['ccc', 'ddd']}),
             ('col7', {'scale': 'DATE'})])