User Guide
Purpose
This section explains detailed usage methods and advanced features of RDEToolKit. After completing basic installation and initial execution, this provides information for more effective utilization of RDEToolKit.
Key Topics
Basic Concepts
- What is Structured Processing - Core concepts and processing flow of RDEToolKit
- Processing Modes - Characteristics and usage of four processing modes
- Directory Structure - Standard file organization of RDE projects
Configuration and Customization
- Configuration File - Behavior control using rdeconfig.yaml and pyproject.toml
- Magic Variables - Dynamic metadata replacement functionality
Practical Usage
- CLI Tools - Detailed command-line operations
- Validation - Data quality verification methods
Advanced Features
- Docker Usage - Environment setup and execution using Docker
Usage Flow
- Concept Understanding: Learn basic concepts in What is Structured Processing
- Environment Setup: Customize behavior with Configuration File
- Practical Application: Utilize features according to specific use cases
- Advanced Usage: Extend functionality with custom processing and plugins
Support Resources
Documentation
- API Reference - Technical specifications of all features
- Developer Guide - Contribution methods
Community
- GitHub Issues - Bug reports and feature requests
- GitHub Discussions - Questions and information exchange
Learning Approach
To effectively learn RDEToolKit, we recommend first understanding the basic concepts in What is Structured Processing, then referring to topics according to your specific use cases.
Next Steps
- For beginners: Start with What is Structured Processing
- To modify settings: Refer to Configuration File
- For advanced features: Check Docker Usage