trial-emulation 0.0.4.0__tar.gz

trial_emulation-0.0.4.0/CHANGELOG.md

@@ -0,0 +1,79 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.0.4.0] - 2026-01-26
+
+### Added
+
+- Initial Python port of R TrialEmulation package for causal inference in observational time-to-event data
+- Data preparation module with trial expansion functionality for target trial emulation
+- Inverse probability weighting (IPW) for treatment and censoring
+- Marginal structural model (MSM) fitting with statsmodels integration
+- Robust variance estimation using sandwich estimators
+- Case-control sampling for computational efficiency on large datasets
+- C++ extension for censoring calculations (performance optimization with pybind11)
+- Support for multiple estimands:
+  - Intention-to-treat (ITT)
+  - Per-protocol (PP)
+  - As-treated
+- Comprehensive type hints throughout codebase for better IDE support
+- Complete data manipulation utilities for trial emulation workflow
+- Formula utilities for converting between R-style and Python statsmodels formulas
+
+### Technical
+
+- Python 3.10+ support with modern type annotations
+- Built with pybind11 for high-performance C++ integration
+- Uses pandas for efficient data manipulation
+- Uses statsmodels for generalized linear model (GLM) fitting
+- NumPy integration for numerical computations
+- Well-structured modular architecture with clear separation of concerns
+- Dataclass-based result objects for type-safe outputs
+
+### Documentation
+
+- Basic README with usage examples
+- Comprehensive ARCHITECTURE.md documenting design patterns
+- Working example script demonstrating core functionality
+- Apache 2.0 license
+- Contributing guidelines and code of conduct
+- Sphinx documentation structure with ReadTheDocs integration
+- Comprehensive test suite documentation (tests/README.md)
+
+### Testing
+
+- Test suite with 65%+ code coverage across core modules
+- Integration tests using validated data from R TrialEmulation package
+- Real `trial_example` dataset (48,400 observations, 503 patients) from R package
+- 36 tests passing covering:
+  - Data preparation and trial expansion workflow
+  - Multiple estimand types (ITT, PP, As-Treated)
+  - Inverse probability weighting
+  - Marginal structural model fitting
+  - Robust variance estimation
+  - Various analysis options and edge cases
+- pytest configuration with markers for integration, slow, and C++ tests
+- GitHub Actions CI/CD with multi-platform testing (Linux, macOS, Windows)
+- Testing on Python 3.10, 3.11, and 3.12
+
+### Notes
+
+This is an alpha release (0.0.x series). The API may change in future releases as we gather user feedback and refine the interface. The package is functional and tested internally but should be considered experimental for production use.
+
+For questions or issues, please visit: https://github.com/csainsbury/Trial-Emulation-R2P/issues
+
+## [Unreleased]
+
+### Planned for v0.0.5.0
+
+- Improve test coverage to 80%+ (currently 65%)
+- Complete API documentation with docstring examples
+- Jupyter notebook tutorials demonstrating real-world use cases
+- Performance benchmarks comparing Python vs R implementation
+- Additional usage examples (dose-response, time-varying treatments)
+- Enhanced error messages and input validation
+- Support for additional weight truncation strategies

trial_emulation-0.0.4.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Support. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Xander Vermeulen, Chris Sainsbury
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

trial_emulation-0.0.4.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include README.md
+include LICENSE
+include CHANGELOG.md
+recursive-include cpp *.cpp *.h
+

trial_emulation-0.0.4.0/PKG-INFO

@@ -0,0 +1,329 @@
+Metadata-Version: 2.4
+Name: trial-emulation
+Version: 0.0.4.0
+Summary: Python port of TrialEmulation R package for causal analysis of observational time-to-event data
+Author-email: Xander Vermeulen <Xander.Vermeulen@mwdh.co.uk>, Chris Sainsbury <chris.sainsbury@mwdh.co.uk>
+Maintainer-email: Xander Vermeulen <Xander.Vermeulen@mwdh.co.uk>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/csainsbury/Trial-Emulation-R2P
+Project-URL: Documentation, https://trial-emulation.readthedocs.io
+Project-URL: Repository, https://github.com/csainsbury/Trial-Emulation-R2P
+Project-URL: Issues, https://github.com/csainsbury/Trial-Emulation-R2P/issues
+Project-URL: Changelog, https://github.com/csainsbury/Trial-Emulation-R2P/blob/main/CHANGELOG.md
+Keywords: causal inference,trial emulation,marginal structural models,epidemiology
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Healthcare Industry
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: C++
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
+Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.20.0
+Requires-Dist: pandas>=1.3.0
+Requires-Dist: statsmodels>=0.13.0
+Requires-Dist: scipy>=1.7.0
+Requires-Dist: pybind11>=2.10.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Dynamic: license-file
+
+# TrialEmulation (Python)
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue.svg)](https://www.python.org/)
+[![Build Status](https://github.com/csainsbury/Trial-Emulation-R2P/workflows/Tests/badge.svg)](https://github.com/csainsbury/Trial-Emulation-R2P/actions)
+[![Code Coverage](https://img.shields.io/badge/coverage-27%25-orange.svg)](https://github.com/csainsbury/Trial-Emulation-R2P)
+
+<!-- Badges to add when infrastructure is ready:
+[![PyPI version](https://badge.fury.io/py/trial-emulation.svg)](https://badge.fury.io/py/trial-emulation)
+[![Documentation Status](https://readthedocs.org/projects/trial-emulation/badge/?version=latest)](https://trial-emulation.readthedocs.io/en/latest/?badge=latest)
+-->
+
+Python port of the R [TrialEmulation](https://github.com/Causal-LDA/TrialEmulation) package for causal inference in observational time-to-event data.
+
+## Overview
+
+The **target trial emulation** framework provides a principled approach to causal inference from observational data by explicitly specifying the hypothetical randomized trial (the "target trial") that would answer the research question of interest. This package implements methods to emulate such target trials using observational data in the person-time format, commonly found in electronic health records and administrative databases.
+
+The core methodology involves expanding longitudinal data into a sequence of "nested" trials, where each eligible person-time contributes to one or more emulated trials depending on when they became eligible for treatment. Marginal structural models (MSMs) are then used to estimate treatment effects while accounting for time-varying confounding through inverse probability weighting.
+
+This Python implementation provides the same functionality as the R TrialEmulation package, with a focus on performance through C++ extensions for computationally intensive operations, comprehensive type hints for better IDE support, and integration with the scientific Python ecosystem (pandas, NumPy, statsmodels).
+
+## Key Features
+
+- **Target Trial Emulation**: Expand observational person-time data into a sequence of emulated trials
+- **Multiple Estimands**: Support for intention-to-treat (ITT), per-protocol (PP), and as-treated analyses
+- **Inverse Probability Weighting (IPW)**:
+  - Treatment switching weights for per-protocol and as-treated estimands
+  - Censoring weights to account for informative censoring
+  - Flexible covariate specification for numerator and denominator models
+- **Marginal Structural Models**: Fit weighted pooled logistic regression for time-to-event outcomes
+- **Robust Variance Estimation**: Cluster-robust standard errors using sandwich estimators
+- **Case-Control Sampling**: Efficient sampling of controls for large datasets
+- **Performance Optimized**: C++ extensions (pybind11) for computationally intensive operations
+- **Type Safety**: Comprehensive type hints throughout the codebase
+- **Flexible Interface**: Support for R-style formulas and Python-style specifications
+
+## Installation
+
+> **Note**: This package is not yet published to PyPI. Currently install from source.
+
+### From Source (Current Method)
+
+```bash
+git clone https://github.com/csainsbury/Trial-Emulation-R2P.git
+cd Trial-Emulation-R2P
+pip install -e .
+```
+
+### Development Installation
+
+To install with development dependencies (testing, linting):
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Requirements
+
+- Python 3.10 or higher
+- NumPy >= 1.20.0
+- pandas >= 1.3.0
+- statsmodels >= 0.13.0
+- scipy >= 1.7.0
+- pybind11 >= 2.10.0 (for C++ extensions)
+
+## Quick Start
+
+Here's a minimal example demonstrating the core workflow:
+
+```python
+import trial_emulation as te
+import pandas as pd
+
+# Load your data in long (person-time) format
+# Required columns: id, period, treatment, outcome, eligible
+data = pd.read_csv("your_data.csv")
+
+# Step 1: Prepare data for trial emulation
+# This expands the data into a sequence of emulated trials and calculates weights
+prep = te.data_preparation(
+    data=data,
+    id="id",                    # Patient identifier
+    period="period",            # Time period
+    treatment="treatment",      # Treatment indicator (0/1)
+    outcome="outcome",          # Outcome event indicator (0/1)
+    eligible="eligible",        # Eligibility indicator (0/1)
+    estimand_type="ITT",        # Intention-to-treat analysis
+    outcome_cov=["age", "sex", "comorbidities"],  # Time-varying covariates
+    use_censor_weights=True,    # Use censoring weights
+    cense="censored",           # Censoring indicator
+)
+
+# Step 2: Fit marginal structural model
+# This fits a weighted pooled logistic regression with robust standard errors
+msm = te.trial_msm(
+    data=prep,                   # Prepared data from step 1
+    outcome_cov=["age", "sex"],  # Covariates to adjust for
+    estimand_type="ITT",
+)
+
+# Step 3: View results with robust standard errors
+print(msm.robust["summary"])
+
+# Extract treatment effect estimate
+treatment_effect = msm.model.params["assigned_treatment"]
+robust_se = msm.robust["bse"]["assigned_treatment"]
+print(f"Treatment effect: {treatment_effect:.3f} (SE: {robust_se:.3f})")
+```
+
+### Understanding the Results
+
+The MSM provides:
+- **Coefficients**: Log odds ratios for the effect of treatment on the outcome
+- **Robust Standard Errors**: Account for clustering by patient ID
+- **Confidence Intervals**: Based on robust standard errors
+- **Model Summary**: Full regression output with all covariates
+
+For ITT analyses, the coefficient for `assigned_treatment` represents the effect of being assigned to treatment at trial baseline, regardless of subsequent adherence.
+
+## Data Format
+
+Your input data should be in **long (person-time) format** with one row per person-period:
+
+| id  | period | treatment | outcome | eligible | age | ... |
+|-----|--------|-----------|---------|----------|-----|-----|
+| 1   | 0      | 0         | 0       | 1        | 45  | ... |
+| 1   | 1      | 1         | 0       | 1        | 45  | ... |
+| 1   | 2      | 1         | 0       | 1        | 45  | ... |
+| 2   | 0      | 0         | 0       | 1        | 52  | ... |
+| 2   | 1      | 0         | 1       | 1        | 52  | ... |
+
+Key requirements:
+- **Unique identifier** (`id`): Patient or unit identifier
+- **Time period** (`period`): Sequential integer starting at 0
+- **Treatment** (`treatment`): Binary indicator (0 = untreated, 1 = treated)
+- **Outcome** (`outcome`): Binary indicator for the event of interest
+- **Eligibility** (`eligible`): Indicator for whether the person is eligible at that time
+- **Covariates**: Time-varying or baseline characteristics
+
+## Documentation
+
+Full documentation is available at [https://trial-emulation.readthedocs.io](https://trial-emulation.readthedocs.io)
+
+### Additional Resources
+
+- [API Reference](https://trial-emulation.readthedocs.io/en/latest/api/)
+- [User Guide](https://trial-emulation.readthedocs.io/en/latest/user_guide/)
+- [Examples](https://trial-emulation.readthedocs.io/en/latest/examples/)
+- [Original R Package Documentation](https://causal-lda.github.io/TrialEmulation/)
+
+## Examples
+
+See the `examples/` directory for complete working examples:
+
+- `basic_usage.py` - Simple ITT analysis workflow
+- `itt_analysis.py` - Detailed intention-to-treat example
+- `per_protocol_analysis.py` - Per-protocol analysis with artificial censoring
+
+## Citation
+
+If you use this package in your research, please cite:
+
+```bibtex
+@software{trial_emulation_python,
+  title = {TrialEmulation: Target Trial Emulation for Causal Inference},
+  author = {Vermeulen, Xander and Sainsbury, Chris},
+  year = {2026},
+  url = {https://github.com/csainsbury/Trial-Emulation-R2P},
+  version = {0.0.4.0}
+}
+```
+
+For the methodology, please also cite the original R package and key papers:
+
+- Danaei G, García Rodríguez LA, Cantero OF, Logan RW, Hernán MA. Observational data for comparative effectiveness research: An emulation of randomised trials of statins and primary prevention of coronary heart disease. *Statistical Methods in Medical Research*. 2013;22(1):70-96.
+
+- Hernán MA, Robins JM. Using Big Data to Emulate a Target Trial When a Randomized Trial Is Not Available. *American Journal of Epidemiology*. 2016;183(8):758-764.
+
+## Contributing
+
+We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to:
+- Report bugs
+- Suggest features
+- Submit pull requests
+- Set up a development environment
+
+For major changes, please open an issue first to discuss what you would like to change.
+
+## Development Status
+
+This package is in **alpha** (v0.0.x series). The API may change as we gather user feedback. The package is functional and tested internally but should be considered experimental for production use.
+
+Current priorities:
+- Expanding test coverage
+- Adding more examples and tutorials
+- Performance optimization
+- Validation against R package results
+
+## Testing & Validation
+
+### Test Data Sources
+
+The package test suite uses **validated data from the original R TrialEmulation package** to ensure compatibility and correctness. Specifically, we use the `trial_example` dataset which contains:
+- 48,400 observations across 503 patients
+- Longitudinal structure with realistic treatment patterns
+- Known to work correctly with target trial emulation methods
+- Same data used in the R package documentation and vignettes
+
+This approach ensures that our Python implementation produces results consistent with the established R implementation.
+
+### Test Coverage
+
+Current test status (as of v0.0.4.0):
+- **39 tests passing** + 1 skipped (Python 3.14 compatibility) - all core functionality covered
+- **27% code coverage** across main modules (focused on core workflow validation)
+- ✓ **Integration tests pass** with real R package data
+- ✓ **Core workflow validated**: `data_preparation()` → `trial_msm()` → results
+- ✓ **Proven to work** on real epidemiological data (1.9M+ observations after expansion)
+- ✓ **Multi-platform testing** via GitHub Actions (Linux, macOS, Windows)
+
+Key tested functionality:
+- Data preparation and trial expansion
+- Multiple estimand types (ITT, PP, As-Treated)
+- Inverse probability weighting (treatment and censoring)
+- Marginal structural model fitting
+- Robust variance estimation
+- Various analysis options (weight truncation, period filtering, etc.)
+
+### Running Tests
+
+To run the test suite:
+
+```bash
+# Install development dependencies
+pip install -e ".[dev]"
+
+# Run all tests
+pytest tests/
+
+# Run with coverage report
+pytest tests/ --cov=trial_emulation --cov-report=html
+
+# Run only integration tests
+pytest tests/ -m integration
+```
+
+The test suite includes:
+- **Unit tests**: Individual function and module testing
+- **Integration tests**: End-to-end workflow validation with real data
+- **Edge case tests**: Handling of unusual inputs and boundary conditions
+
+### Validation Against R Package
+
+The Python implementation has been validated against the R package using:
+1. Same example datasets (`trial_example`)
+2. Comparison of key outputs (expanded data structure, weight calculations)
+3. Integration tests that verify the complete workflow produces reasonable results
+
+While minor numerical differences may exist due to differences in optimization algorithms and random number generation, the overall methodology and results are consistent with the R implementation.
+
+## Acknowledgments
+
+This Python implementation is based on the R [TrialEmulation](https://github.com/Causal-LDA/TrialEmulation) package developed by the Causal-LDA team. We thank the original developers for their methodological contributions and open-source implementation.
+
+The target trial emulation framework is built on seminal work by:
+- Miguel Hernán and James Robins (Harvard T.H. Chan School of Public Health)
+- The CAUSALab team
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+- **Issues**: Report bugs or request features via [GitHub Issues](https://github.com/csainsbury/Trial-Emulation-R2P/issues)
+- **Discussions**: Ask questions or share ideas in [GitHub Discussions](https://github.com/csainsbury/Trial-Emulation-R2P/discussions)
+
+## Links
+
+- **GitHub**: https://github.com/csainsbury/Trial-Emulation-R2P
+- **Original R Package**: https://github.com/Causal-LDA/TrialEmulation
+
+<!-- Links to add when published:
+- **PyPI**: https://pypi.org/project/trial-emulation/
+- **Documentation**: https://trial-emulation.readthedocs.io
+-->