import_vcf
Import VCF files (.vcf or .vcf.gz) into Gigwa databases, projects, and runs. Supports replacing existing project data and returning progress tokens.
Instructions
Import a VCF file (.vcf or .vcf.gz) into Gigwa.
Uploads the VCF to create/append a database (module), project and
run. technology is optional free-text (e.g. 'WGS', 'GBS'). Use
clear_project_data=True to replace existing project data and wait=False
to return a progress token instead of blocking.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| run | Yes | Target run name within the project. | |
| wait | No | Block until the import finishes (True) or return a progress token immediately (False). | |
| module | Yes | Target Gigwa database (module) name. | |
| ploidy | No | Sample ploidy (default 2). | |
| project | Yes | Target project name within the database. | |
| vcf_path | Yes | Path to the VCF file (.vcf or .vcf.gz) to import. | |
| technology | No | Free-text genotyping technology label (e.g. 'DArTseq', 'WGS', 'GBS'). | |
| skip_monomorphic | No | Drop non-variant (monomorphic) markers during import. | |
| clear_project_data | No | Replace any existing data in the project before importing. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |