API Reference

• Dataset and its Components
  • Component
    • Component.id
    • Component.type
    • Component.get()
    • Component.get_identifiers()
    • Component.options()
  • Dataset
    • Dataset.id
    • Dataset.components
    • Dataset.name
    • Dataset.add()
    • Dataset.index()
    • Dataset.report()
    • Dataset.query()
    • Dataset.get()
    • Dataset.get_identifiers()
    • Dataset.options()
    • Dataset.type
• Database and DBManager
  • DBManager
    • DBManager.Session
    • DBManager.connection
    • DBManager.session
  • Database
    • Database.id
    • Database.name
    • Database.host
    • Database.backend
    • Database.connection
    • Database.worksheet
    • Database.meta
    • Database.token
    • Database.build_column()
    • Database.build_constraint()
    • Database.create_table()
    • Database.connect()
    • Database.get_primary()
    • Database.get_records()
    • Database.to_table()
    • Database.resolve_dups()
    • Database.resolve_fks()
    • Database.report()
    • Database.query()
    • Database.get()
    • Database.get_identifiers()
    • Database.options()
    • Database.type
  • check_for_key()
  • migrate()
  • reshape()
  • replace_value()
  • replace_column()
  • transform()
  • transform_column()
  • validate()
  • validate_column()
• Layout, File, and Tag
  • Layout
    • Layout.id
    • Layout.url
    • Layout.specification
    • Layout.files
    • Layout.root
    • Layout.specification_name
    • Layout.add()
    • Layout.clone()
    • Layout.index()
    • Layout.query()
    • Layout.move_root()
    • Layout.report()
    • Layout.get()
    • Layout.get_identifiers()
    • Layout.options()
    • Layout.type
  • File
    • File.id
    • File.root
    • File.layout
    • File.tags
    • File.path
    • File.attached
    • File.rel_path
    • File.download()
    • File.index()
    • File.report()
    • File.get()
    • File.get_identifiers()
    • File.options()
  • Tag
    • Tag.id
    • Tag.files
    • Tag.name
    • Tag.value
    • Tag.get()
    • Tag.get_identifiers()
    • Tag.options()
  • Marking
    • Marking.file_id
    • Marking.get()
    • Marking.get_identifiers()
    • Marking.options()
    • Marking.tag_id
    • Marking.name
• Specification
  • Specification
    • Specification.name
    • Specification.details
    • Specification.build_path()
    • Specification.create_from_file()
    • Specification.extract_tags()
    • Specification.get()
    • Specification.organize()
    • Specification.tags
    • Specification.get_identifiers()
    • Specification.options()
    • Specification.validate_path()
• Indexing
  • Indexer
    • Indexer.__init__()
    • Indexer.add()
    • Indexer.commit()
    • Indexer.get()
    • Indexer.options()
    • Indexer.retrieve()
    • Indexer.rollback()
    • Indexer.session
    • Indexer.read_only
• File format conversion
  • dcm2nii()
  • edf2asc()
  • nirx2snirf()
  • eeg_converter()
  • convert()
• Unique Objects
  • unique()
  • uniquify()
• Utilities
  • Library-specific
    • create_tutorial_dataset()
  • Dataframe Manipulation
    • common_rows()
    • convert_column_type()
    • python_to_pandas_type()
  • Logging
    • log_df()
    • log_col()
  • General-purpose
    • commafy()
    • copy()
    • deep_get()
    • denest_dict()
    • filename()
    • get_dir_contents()
    • get_incomplete_keys()
    • get_metadata()
    • listify()
    • read_yaml()
    • read_multi_yaml()
    • run_shell()