Introduction¶
What is table remodeler?¶
Table Remodeler is a Python package that provides flexible tools for transforming and reorganizing tabular data files. It’s particularly useful for processing event files in neuroimaging research and supports HED (Hierarchical Event Descriptors) annotations.
Key features¶
Operation-based architecture: Apply transformations through a series of composable operations
JSON configuration: Define remodeling pipelines in JSON for reproducible workflows
HED support: Built-in operations for working with HED-annotated event files
Backup & restore: Automatic backup management before applying changes
Command-line interface: Easy-to-use CLI tools for batch processing
Extensible: Create custom operations by extending the
BaseOpclass
Installing table remodeler¶
You can install table-remodeler from PyPI:
pip install table-remodeler
Or install directly from the GitHub repository:
pip install git+https://github.com/hed-standard/table-remodeler.git
For development installation with testing tools:
git clone https://github.com/hed-standard/table-remodeler.git
cd table-remodeler
pip install -e ".[dev,test]"
Example usage¶
Command line¶
# Run remodeling operations
run_remodel /path/to/dataset operations.json
# Create a backup
run_remodel_backup /path/to/dataset
# Restore from backup
run_remodel_restore /path/to/dataset
Python api¶
from remodel import Dispatcher
operations = [
{"operation": "remove_columns", "parameters": {"column_names": ["unwanted_col"]}},
{"operation": "rename_columns", "parameters": {"column_mapping": {"old": "new"}}}
]
dispatcher = Dispatcher(operations, data_root="/path/to/dataset")
dispatcher.run_operations()
Finding help¶
📖 User Guide - Tutorials and examples
📚 API Reference - API documentation
🔗 GitHub Repository - Source code and issues
🔗 Related Projects - HED and related tools