ObjTables documentation¶
ObjTables is a toolkit which makes it easy to use spreadsheets (e.g., XLSX workbooks) to work with complex datasets by combining spreadsheets with rigorous schemas and an object-relational mapping system (ORM; similar to Active Record (Ruby), Django (Python), Doctrine (PHP), Hibernate (Java), Propel (PHP), SQLAlchemy (Python), etc.). This combination enables users to use programs such as Microsoft Excel, LibreOffice Calc, and OpenOffice Calc to view and edit spreadsheets and use schemas and the ObjTables software to validate the syntax and semantics of datasets, compare and merge datasets, and parse datasets into object-oriented data structures for further querying and analysis with languages such as Python.
ObjTables makes it easy to:
Use collections of tables (e.g., an XLSX workbook) to represent complex data consisting of multiple related objects of multiple types (e.g., rows of worksheets), each with multiple attributes (e.g., columns).
Use complex data types (e.g., numbers, strings, numerical arrays, symbolic mathematical expressions, chemical structures, biological sequences, etc.) within tables.
Use programs such as Excel and LibreOffice as a graphical interface for viewing and editing complex datasets.
Use embedded tables and grammars to encode relational information into columns and groups of columns of tables.
Define clear schemas for tabular datasets.
Use schemas to rigorously validate tabular datasets.
Use schemas to parse tabular datasets into data structures for further analysis in languages such as Python.
Compare, merge, split, revision, and migrate tabular datasets.
The ObjTables toolkit includes five components:
Format for schemas for tabular datasets
Numerous data types
Format for tabular datasets
Software tools for parsing, validating, and manipulating tabular datasets
Python package for more flexibility and anal
Please see https://www.objtables.org for an overview of ObjTables and https://sandbox.karrlab.org/tree/obj_tables for interactive tutorials for the ObjTables Python API. This website contains documentation for ObjTables migrations and the ObjTables Python API.
Contents¶
- 1. Installation
- 2. Migration a dataset between versions of its schema
- 3. API documentation
- 3.1. obj_tables package
- 3.1.1. Subpackages
- 3.1.2. Submodules
- 3.1.3. obj_tables.__main__ module
- 3.1.4. obj_tables._version module
- 3.1.5. obj_tables.abstract module
- 3.1.6. obj_tables.core module
- 3.1.7. obj_tables.grammar module
- 3.1.8. obj_tables.io module
- 3.1.9. obj_tables.migrate module
- 3.1.10. obj_tables.utils module
- 3.1.11. obj_tables.web_service module
- 3.1.12. Module contents
- 3.1. obj_tables package
- 4. About