Convert-Pheno Documentation
Overview
Convert clinical and phenotypic data between formats.
Convert-Pheno reads clinical data exports and writes files in a selected target format. See Supported Formats for available inputs and outputs.
Project status
This documentation tracks Convert-Pheno 0.35.
The established routes are used in research projects and covered by regression tests. Routes marked experimental have been tested with fewer independent datasets; their format guides state the current coverage.
Choose an interface
The CLI suits terminal users, scripts, and automated workflows. Desktop provides a graphical interface for local conversions; no command-line knowledge is needed.
Developers can integrate the same conversion engine through the HTTP(s) API or Perl/Python interfaces.
Typical conversionsβ
Examples include:
- convert Phenopackets to Beacon collections, or Beacon individuals to Phenopackets
- convert OMOP-CDM exports to Beacon
- map REDCap or CSV fields to Beacon or OMOP-CDM using a mapping file
- convert FHIR, CDISC Dataset-JSON, or Dataset-XML to Beacon or Phenopackets
- export Beacon individuals as OMOP-CDM tables, flattened CSV, or JSON-LD
Where to startβ
- 5-Minute Quickstart runs one small PXF-to-BFF conversion using the CLI
- Command-Line Interface explains the CLI and links to commands grouped by input format
- Supported Formats summarizes accepted files and outputs
- Mapping Files explains project-specific CSV, REDCap, and ODM mappings
- Desktop Application covers the native interface available from version 0.35
- Troubleshooting helps with installation and input errors
Developer interfacesβ
- Module for local Perl or Python code
- API for HTTP(s) requests and the OpenAPI contract
- Implementation for the route registry and execution model
Source code: GitHub repository.