omic/synthea-alldiseases
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Trying to fix basic functionality again.

Browse Source
This commit is contained in:
Gabe Richman
2025-03-23 11:53:47 -07:00
parent ebda48190a
commit 2141e81f42
406 changed files with 173963 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

189
README.md
View File

@@ -1,93 +1,144 @@
# synthea-alldiseases
# Synthea All Diseases
A comprehensive pipeline for generating Synthea modules and synthetic patient data for any disease.
## Overview
## Getting started
This pipeline leverages Nextflow to orchestrate the generation of disease modules and synthetic patient data using Synthea. It supports:
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
1. Automatic generation of disease modules using Claude AI
2. Synthetic patient generation with configurable parameters using the actual Synthea engine
3. Analysis of generated patient data
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Requirements
## Add your files
- Docker
- Docker Compose
- Nextflow (version 20.10.0 or higher)
- Java (required by Nextflow)
- Python 3.6+ (if running scripts directly)
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
## Quick Start
```
cd existing_repo
git remote add origin https://gitlab.com/omic/next/registry/tools/synthea-alldiseases.git
git branch -M master
git push -uf origin master
The easiest way to get started is to use our convenience scripts:
```bash
# Set up the environment (builds Docker containers and prepares directories)
./scripts/prepare_environment.sh
# Run the pipeline for a specific disease
./scripts/run_pipeline.sh --disease "Parkinson's Disease" --patients --population 50
```
## Integrate with your tools
## Manual Setup
- [ ] [Set up project integrations](https://gitlab.com/omic/next/registry/tools/synthea-alldiseases/-/settings/integrations)
1. Clone this repository:
```bash
git clone https://github.com/yourusername/synthea-alldiseases.git
cd synthea-alldiseases
```
## Collaborate with your team
2. Create a `.env` file with your API keys (or copy from `.env.example`):
```bash
cp .env.example .env
# Edit .env with your preferred text editor
```
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
3. Build and start the Docker containers:
```bash
docker-compose build
docker-compose up -d synthea
```
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
### Basic Command
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
```bash
nextflow run main.nf --disease_name "Disease Name" [options]
```
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
### Examples
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
Generate a module for Hypertension and create 100 patients:
```bash
nextflow run main.nf --disease_name "Hypertension" --generate_patients true --population 100 --gender 0.6
```
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
Generate a module for Parkinson's Disease, create 50 patients, and analyze the data:
```bash
nextflow run main.nf --disease_name "Parkinson's Disease" --generate_patients true --population 50 --analyze_patient_data true
```
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
### Parameters
| Parameter | Description | Default |
|-----------|-------------|---------|
| `--disease_name` | Name of the disease to model | (required) |
| `--modules_dir` | Directory for modules | `modules` |
| `--output_dir` | Directory for output files | `output` |
| `--generate_patients` | Generate patient data | `false` |
| `--population` | Number of patients to generate | `100` |
| `--gender` | Gender distribution (0-1 for % female) | `0.5` |
| `--min_age` | Minimum patient age | `0` |
| `--max_age` | Maximum patient age | `90` |
| `--seed` | Random seed for reproducibility | (random) |
| `--analyze_patient_data` | Analyze generated data | `false` |
| `--report_format` | Format for analysis report | `html` |
| `--force_generate` | Force regeneration of modules | `false` |
| `--publish_dir` | Directory for published output | `published_output` |
## Understanding the Data Flow
1. **Module Generation**: The pipeline first looks for an existing module for the specified disease. If not found, it generates one using the module_generator.
2. **Patient Generation**: If requested, the pipeline uses the actual Synthea engine to generate synthetic patient data based on the disease module.
3. **Analysis**: If requested, the pipeline analyzes the generated patient data and produces reports.
## Directory Structure
- `modules/`: Contains generated disease modules
- `module_generator/`: Contains the AI-powered module generation scripts
- `scripts/`: Utility scripts for the pipeline
- `output/`: Generated patient data (temporary)
- `published_output/`: Final output data that persists between runs
- `published_output/modules/`: Contains the generated modules
- `published_output/{disease_name}/`: Contains patient data for each disease
## Convenience Scripts
- `scripts/prepare_environment.sh`: Sets up the environment and starts containers
- `scripts/run_pipeline.sh`: Simplified interface for running the pipeline
- `scripts/analyze_patient_data.py`: Analyzes generated patient data
- `scripts/check_condition_structure.py`: Validates module JSON structure
## Troubleshooting
If you encounter issues:
1. Check that Docker containers are running:
```bash
docker ps | grep synthea
```
2. Ensure your modules directory has the required modules:
```bash
ls -la modules/
```
3. Check logs for detailed error messages:
```bash
tail -f .nextflow.log
```
4. Try rebuilding the Docker containers:
```bash
docker-compose down
docker-compose build
docker-compose up -d synthea
```
5. If module generation fails, check that your API keys are correctly set in the .env file
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
This project uses the same license as Synthea.