Welcome to RePORTaLiN Documentation
RePORTaLiN is a robust data extraction pipeline for processing medical research data from Excel files to JSONL format with advanced PHI/PII de-identification capabilities.
Current Version: |version| (October 28, 2025)
Quick Links
- 📚 New to RePORTaLiN? Start here:
Quick Start - Get started in 5 minutes
Installation - Complete installation guide
Usage Guide - Detailed usage instructions
- 🔧 For Developers:
Contributing - How to contribute
Architecture - Technical architecture
API Reference - Complete API reference
- 📋 Reference:
Changelog - Version history and updates
Code Integrity Audit - Code quality metrics
Key Features
- 🌍 Multi-Country Privacy Compliance
14 countries supported (US, IN, ID, BR, PH, ZA, EU, GB, CA, AU, KE, NG, GH, UG)
HIPAA, GDPR, LGPD, DPDPA, POPIA compliance
21 PHI/PII identifier types detected and pseudonymized
- 🔒 Security & Performance
Encryption by default (AES-128)
Fast processing with optimized algorithms
Date shifting with temporal relationship preservation
Audit trails for compliance validation
- 📊 Data Processing
Multi-table detection from complex Excel layouts
JSONL output for efficient streaming
Progress tracking with real-time feedback
Duplicate detection and intelligent column handling
- 🔧 Robust Configuration
Enhanced error handling
Auto-detection of dataset folders
Type-safe with full type hints
Cross-platform support (macOS, Linux, Windows)
What’s New in 0.8.5
See Changelog for complete version history and detailed release notes.
Documentation Sections
👥 For Users - Learn how to install and use RePORTaLiN
👥 User Guide
- Introduction
- Installation
- Quick Start
- What Does RePORTaLiN Do?
- Prerequisites
- Expected Output
- Understanding the Output
- Viewing the Results
- Command-Line Options
- Using Make Commands
- Working with Different Datasets
- Checking the Logs
- Common First-Run Issues
- Step-by-Step Execution
- Advanced Usage: De-identification
- Troubleshooting
- Common Use Cases
- Next Steps
- Configuration
- Usage Guide
- De-identification
- Country-Specific Privacy Rules
- Troubleshooting
🔧 For Developers - Contribute to RePORTaLiN development
🔧 Developer Guide
- Architecture
- Project Vision: RAG Transformation
- Contributing
- Extending RePORTaLiN
- Working with Data Dictionary Module
- Working with Data Extraction Module
- Working with Configuration Module
- Adding New Output Formats
- Adding Data Transformations
- Adding Custom Logging
- Adding Database Support
- Adding Parallel Processing
- Adding Custom Table Detection
- Adding Plugin System
- Configuration File Support
- Adding New Country Regulations
- Best Practices for Extensions
- See Also
- Sphinx Auto-Documentation Guide
- Code Integrity Audit
- Production Readiness Assessment
- Assessment for Version 0.8.5
- Executive Summary
- Code Quality Metrics
- Module-by-Module Review
- Security Assessment
- Logical Flow Analysis
- Code Coherence
- Documentation Review
- Testing & Validation
- Known Limitations
- Recommendations
- Conclusion
- Appendix: Testing Summary
- Review Checklist
- Verification Tests Performed
- Final Recommendations
- GitHub Pages Automatic Deployment
- Documentation Style Guide
- Core Documentation Principles
- Overview
- File Format Standards
- Audience-Specific Headers
- Language and Tone
- Formatting Standards
- Version Information
- Maintenance Standards
- Automated Compliance
- Common Patterns
- Documentation Policy & Enforcement
- Documentation Maintenance Checklist
- Resources
- Related Documentation
- Documentation Maintenance Summary
- Historical Verification Archive
- Future Enhancements
📚 API Reference - Technical documentation for all modules
📚 API Reference
- API Reference
- main module
- config module
- scripts package
📋 Additional Information
Note
📖 Documentation Modes
This documentation can be built in two modes:
User Mode (
make user-mode): Shows only user-facing documentationDeveloper Mode (
make dev-mode): Includes developer guides and API documentation
Alternatively, set the DEVELOPER_MODE environment variable (True/False)
or edit conf.py and set developer_mode = True or False.