Skip to navigation

indexgvcf

View as Markdown

This tool creates an index for a VCF(vcf.gz) or GVCF(g.vcf/g.vcf.gz) file. The index file name is determined by appending .tbi to the name of the vcf.gz/g.vcf.gz file, or .idx to the name of the g.vcf file being indexed, and is created in the same directory as the VCF/GVCF file itself.

Please note that haplotypecaller and deepvariant also write the index file when generating a .gz output.

Refer to the indexgvcf Reference section for a detailed listing of all available options.

Quick Start

# This command assumes all the inputs are in the current working directory and all the outputs go to the same place.
docker run --rm --gpus all --volume $(pwd):/workdir --volume $(pwd):/outputdir \
--workdir /workdir \
nvcr.io/nvidia/clara/clara-parabricks:4.8.0-1 \
pbrun indexgvcf \
--input /workdir/${INPUT_GVCF}

Compatible CPU GATK4 Command

$ gatk IndexFeatureFile -I <INPUT_DIR>/${INPUT_GVCF}

Options

TypeNameRequired?Description
I/O--input INPUTYesPath to the g.vcf/g.vcf.gz file to be indexed.
Runtime--verboseNoEnable verbose output.
Runtime--x3NoShow full command line arguments.
Runtime--dry-runNoCheck if the current command is valid.
Runtime--logfile LOGFILENoPath to the log file. If not specified, messages will only be written to the standard error output.
Runtime--tmp-dir TMP_DIRNoFull path to the directory where temporary files will be stored. (default: .)
Runtime--with-petagene-dir WITH_PETAGENE_DIRNoFull path to the PetaGene installation directory. By default, this should have been installed at /opt/petagene. Use of this option also requires that the PetaLink library has been preloaded by setting the LD_PRELOAD environment variable. Optionally set the PETASUITE_REFPATH and PGCLOUD_CREDPATH environment variables that are used for data and credentials. Optionally set the PetaLinkMode environment variable that is used to further configure PetaLink, notably setting it to "+write" to enable outputting compressed BAM and .fastq files.
Runtime--keep-tmpNoDo not delete the directory storing temporary files after completion.
Runtime--no-seccomp-overrideNoDo not override seccomp options for docker.
Runtime--versionNoView compatible software versions.
Runtime--preserve-file-symlinksNoOverride default behavior to keep file symlinks intact and *not* resolve the symlink.
Runtime--help-jsonNoPrint out help message in JSON format.