Fix CLI subcommands to match actual TileDB-VCF interface

- Replace incorrect subcommands (create-dataset, ingest, list-datasets)
- Use correct subcommands: create, store, export, list, stat, utils, version
- Update examples to match actual CLI usage patterns
- Add comprehensive list of all available subcommands with descriptions
This commit is contained in:
Jeremy Leipzig
2026-02-24 11:08:13 -07:00
parent 3f76537f75
commit b4b8572244

View File

@@ -269,28 +269,34 @@ ds = tiledbvcf.Dataset(uri="gcs://bucket/dataset", mode="r")
## CLI Usage ## CLI Usage
TileDB-VCF provides a powerful command-line interface: TileDB-VCF provides a command-line interface with the following subcommands:
**Available Subcommands:**
- `create` - Creates an empty TileDB-VCF dataset
- `store` - Ingests samples into a TileDB-VCF dataset
- `export` - Exports data from a TileDB-VCF dataset
- `list` - Lists all sample names present in a TileDB-VCF dataset
- `stat` - Prints high-level statistics about a TileDB-VCF dataset
- `utils` - Utils for working with a TileDB-VCF dataset
- `version` - Print the version information and exit
```bash ```bash
# Create and ingest data # Create empty dataset
tiledbvcf create-dataset --uri my_dataset tiledbvcf create --uri my_dataset
tiledbvcf ingest --uri my_dataset sample1.vcf.gz sample2.vcf.gz
# Query and export # Ingest samples (requires single-sample VCFs with indexes)
tiledbvcf store --uri my_dataset --samples sample1.vcf.gz,sample2.vcf.gz
# Export data
tiledbvcf export --uri my_dataset \ tiledbvcf export --uri my_dataset \
--regions "chr1:1000000-2000000" \ --regions "chr1:1000000-2000000" \
--sample-names "sample1,sample2" \ --sample-names "sample1,sample2"
--output-format bcf \
--output-path output.bcf
# List dataset info # List all samples
tiledbvcf list-datasets --uri my_dataset tiledbvcf list --uri my_dataset
# Export as TSV # Show dataset statistics
tiledbvcf export --uri my_dataset \ tiledbvcf stat --uri my_dataset
--regions "chr1:1000000-2000000" \
--tsv-fields "CHR,POS,REF,ALT,S:GT" \
--output-format tsv
``` ```
## Advanced Features ## Advanced Features